/juno-core

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

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

Juno - Codacy Badge CodeQL CircleCI Maintainability

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

  1. Download the code to your local machine
  2. Run yarn to install all packages
  3. Create a file called .env in the root of the project
  4. Add REACT_APP_BACKEND_URL=YOUR_BACKEND_URL to the .env file - the current default is http://localhost:5001
  5. Set up the backend server via the steps here
  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: Dhr_RT#5882

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.

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 forwarding, cc/bcc options.

⚠️ The current codebase doesn't support tests yet. Looking for suggestions and contributions.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.