ProtonMail / proton-contacts

React web application to manage ProtonMail contacts
54 stars 19 forks source link

proton-contacts

Proton Contacts built with React.

⚠ If you use Windows plz follow this document before anything else how to prepare Windows

Basic installation

To set up the project, follow the steps below:

  1. Create a file appConfig.json at the root of your project. To set up the dev env config for this app, add the clientiD <clientID> inside appConfig.json (cf. How to dev)
{
    "appConfig": {
        "clientId": "WebSettings"
    }
}
  1. npm install

  2. npm start

:warning: Do not commit appConfig.json . Notice it's already inside .gitignore

Deploy

Currently available in the deploy-contacts branch.

  1. Create a new version + tag => npm version (patch|minor|major).

  2. Deploy via npm npm run deploy.

Deploy to prod

$ npm run deploy:prod

Build from master post git clone into /tmp. --no-remote build from local.

CLI Flags

:rocket: Create a new version (before deploy)

This command will:

$ npx proton-version <patch|minor|major>

Default is patch

If you want to force the update of all dependencies add the flag --all;

By default it provides a prompt and ask you what you want to update etc.

If you have an active npm link it will remove it from your node_modules.