|
1 | 1 | # Criptext Email React Client |
2 | 2 |
|
3 | | -This project manages the email client for desktop developed using Electron and React. |
| 3 | +Finally, an email service that's built around your privacy. Get your @criptext.com email address and see what it's like to have peace of mind and privacy in every email you send. |
4 | 4 |
|
5 | | -The project contains subdirectories according to each module of the app: |
| 5 | +## Features |
| 6 | + |
| 7 | +- End-to-end Encryption: Criptext uses the open source Signal Protocol library to encrypt your emails. Your emails are locked with a unique key that‘s generated and stored on your device alone, which means only you and your intended recipient can read the emails you send. |
| 8 | +- No data collection: unlike every other email service out there, Criptext doesn't store your emails in its servers. Instead, your entire inbox is stored exclusively on your device. |
| 9 | +- Easy to use: our app is designed to work as simple as any other email app — so much so, you'll forget how secure it is. |
| 10 | + |
| 11 | +## Contributing Bug reports |
| 12 | + |
| 13 | +We use GitHub for bug tracking. Please search the existing issues for your bug and create a new one if the issue is not yet tracked! |
| 14 | + |
| 15 | +## Dependencies |
| 16 | + |
| 17 | +To build Criptext on your machine you'll need: |
| 18 | + |
| 19 | +* Node.js (Recommended 8.12+) |
| 20 | +* Yarn |
| 21 | + |
| 22 | +## Run locally |
| 23 | + |
| 24 | +Clone this repository and run a few scripts: |
| 25 | + |
| 26 | +``` bash |
| 27 | +git clone https://github.com/Criptext/Criptext-Email-React-Client |
| 28 | +cd Criptext-Email-React-Client |
| 29 | +node install.js # install dependencies |
| 30 | +node start.js # Run locally |
| 31 | +``` |
| 32 | + |
| 33 | +On some directories, like `email_login` it is recommended to have a .env file |
| 34 | +with the following content: |
| 35 | + |
| 36 | +``` |
| 37 | +SKIP_PREFLIGHT_CHECK=true |
| 38 | +``` |
| 39 | +## Contributing Code |
| 40 | + |
| 41 | +Contributions are welcome. This project contains subdirectories according to each module of the app: |
6 | 42 | * electron_app: contains the files needed to run electron and load the app views |
7 | 43 | * email_mailbox: contains the main view of the app which is made-up of the mailbox itself, settings, contacts, etc. |
8 | | -* email_composer: contains the view and code that handles the edition of a new email |
9 | | -* email_login: contains the view and code that handles user login |
10 | | -* email_loader: contains the view and code that handles loading views between modules |
| 44 | +* email_composer: contains the view and code that handles the window that edits new emails. |
| 45 | +* email_login: contains the views and code that handles user sign in and sign up. |
| 46 | +* email_loader: contains the views and code that handles spinners and progress bars between window transitions. |
| 47 | + |
| 48 | + |
| 49 | +The main application logic is the `electron_app` dir. |
| 50 | +Before submitting any patches to the main application run the linter and tests: |
| 51 | + |
| 52 | +``` bash |
| 53 | +yarn lint # Run the linter |
| 54 | +yarn test # Run unit tests |
| 55 | +yarn integration # Run integrations |
| 56 | +``` |
| 57 | + |
| 58 | +The other directories are React Apps built with [create-react-app]( |
| 59 | +https://github.com/facebook/create-react-app) used as the UI of the main |
| 60 | +application. Please note that they won't work on the browser because they |
| 61 | +require electron APIs. Once again, Before submitting any patches run the linter |
| 62 | +and tests: |
| 63 | + |
| 64 | +``` bash |
| 65 | +yarn lint |
| 66 | +yarn test |
| 67 | +``` |
| 68 | + |
| 69 | +## Support |
| 70 | + |
| 71 | +For troubleshooting and questions, please write us at < a href= "mailto:[email protected]"> [email protected]</ a> |
| 72 | + |
| 73 | +## License |
| 74 | + |
| 75 | +Copyright 2018 Criptext Inc. |
| 76 | + |
| 77 | +Licensed under the GPLv2: http://www.gnu.org/licenses/gpl-2.0.html |
0 commit comments