Skip to content

Commit e6c0cb3

Browse files
Update README
1 parent d8cd673 commit e6c0cb3

File tree

3 files changed

+36
-112
lines changed

3 files changed

+36
-112
lines changed

README.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Finally, an email service that's built around your privacy. Get your @criptext.c
1111
## Contributing Bug reports
1212

1313
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+
[https://github.com/Criptext/Criptext-Email-React-Client/issues](https://github.com/Criptext/Criptext-Email-React-Client/issues)
1415

1516
## Contributing Translations
1617

@@ -22,7 +23,7 @@ We use Lokalise for translations. If you are interested in helping please write
2223

2324
To build Criptext on your machine you'll need:
2425

25-
* Node.js (Recommended 8.12+)
26+
* Node.js (Recommended 8.15+)
2627
* Yarn
2728

2829
## Run locally
@@ -32,16 +33,40 @@ Clone this repository and run a few scripts:
3233
``` bash
3334
git clone https://github.com/Criptext/Criptext-Email-React-Client
3435
cd Criptext-Email-React-Client
35-
node install.js # Install dependencies
36-
node start.js # Run locally
36+
node install.js # Install dependenciess
3737
```
3838

39-
On some directories, like `email_login` it is recommended to have a .env file
39+
To up all projects, got to each project and run:
40+
``` bash
41+
yarn start # Run locally
42+
```
43+
First up the projects like `email_*` and last `electrop_app`
44+
45+
On all directories, like `email_*` it is recommended to have a .env file
4046
with the following content:
4147

4248
```
49+
PORT=####
4350
SKIP_PREFLIGHT_CHECK=true
51+
REACT_APP_APPDOMAIN=criptext.com
52+
REACT_APP_AVATAR_URL=https://api.criptext.com/user/avatar/
53+
```
54+
55+
The project `electrop_app` the .env file should have this:
56+
```
57+
NODE_ENV=development
58+
MAILBOX_URL=http://localhost:####
59+
LOGIN_URL=http://localhost:####
60+
LOADING_URL=http://localhost:####
61+
COMPOSER_URL=http://localhost:####
62+
DEV_SOCKET_URL=wss://socket.criptext.com
63+
DEV_SERVER_URL=https://api.criptext.com
64+
DEV_DATA_TRANSFER_URL=https://transfer.criptext.com
65+
CSC_IDENTITY_AUTO_DISCOVERY=true
66+
DEV_APP_DOMAIN=criptext.com
4467
```
68+
69+
4570
## Contributing Code
4671

4772
Contributions are welcome. This project contains subdirectories according to each module of the app:

install.js

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,28 @@ const { spawn } = require('child_process')
66
const abs = r => path.join(__dirname, r);
77

88
const packageDirs = [
9-
abs('electron_app'),
109
abs('email_composer'),
1110
abs('email_loading'),
1211
abs('email_login'),
13-
abs('email_mailbox')
12+
abs('email_mailbox'),
13+
abs('electron_app')
1414
]
1515

1616
const installModules = cwd =>
1717
new Promise((resolve, reject) => {
1818
const cp = spawn('yarn', [], { cwd });
19+
const names = cwd.split('/');
20+
const nameProject = names[names.length-1];
1921
cp.on('exit', code => {
2022
code == 0
21-
? resolve()
23+
? resolve(`Project ${nameProject} installed ...wait`)
2224
: reject(` Failed to install modules at ${cwd}.\n Yarn exited with code: ${code}`)
2325
});
24-
})
26+
}).then(value => {console.log(value)});
2527

2628
const installations = Promise.all(packageDirs.map(installModules));
2729

2830
installations.then(
29-
() => console.log(' Installed modules successfully!'),
31+
() => console.log('Installed modules successfully!'),
3032
err => console.error(err)
3133
);

start.js

Lines changed: 0 additions & 103 deletions
This file was deleted.

0 commit comments

Comments
 (0)