Skip to content

Open Source React Email Application connected to Gmail that is fast and easy to use via web.

License

Notifications You must be signed in to change notification settings

yakirk/juno-core

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Juno - Codacy Badge CodeQL CircleCI Maintainability discord Juno Core

Juno is an Open Source React based Gmail application.

  • A minimalistic design for less cognitive load, so you can use your brain for the needed work.
  • Go through your emails with minimal clicks.
  • Keep clear track of your to-do emails and new emails.

Getting Started

There are two ways to get started. With installer or without installer.

With installer

  1. Fork the juno-core repository
  2. Run npx create-juno-dev-env in the same parent folder as where you forked the repository
  3. When using cloud backend request to be added to the Google Test users via Discord, if you want to run local follow the steps here

Without installer

  1. Download the code to your local machine - and run yarn to install all packages
  2. Create a file called .env in the root of the project
  3. If you want to run the backend on your local - set up the backend server via the steps here, else continue to the next step.
  4. Add VITE_BACKEND_URL=YOUR_BACKEND_URL to the .env file - the current default is http://localhost:5001- If you wish to work with our hosted cloud backend, so you don't have to manage the backend you have to set: VITE_USE_LOCAL_FRONTEND_CLOUD_BACKEND=true and VITE_BACKEND_URL=https://juno-backend-service-dev.herokuapp.com. And request to be added to the Google Test users via Discord
  5. All the other values given as an example in .env.example are optional.
  6. Run the app via yarn start. Open http://localhost:3000 to view it in the browser

Contributing

Thank you for using Juno 😎 . With the help of its contributors, your experience with email will be as good as possible 🚀.

Looking for a first issue to tackle?

  • Issues tagged with good first issue are a good place to start.
  • Or contact me via Discord

Contributing guidelines

  • When encountering a bug, create a Github issue with the bug label in the active project. Be as specific as possible.
  • To suggest a new feature, create a Github issue with the enhancement label in the active project.

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser. Your system should run on the development dev branch to be in sync with the latest development changes.

The page will reload if you make edits.
You will also see any lint errors in the console.

Roadmap

For the Roadmap of this project please check this. The current focus is to stabilize the app and adding some core mail features, such as composing with attachments.

About

Open Source React Email Application connected to Gmail that is fast and easy to use via web.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 99.7%
  • Other 0.3%