Developer Guide

Commit terminology

"Folders/files changed - Modification code: commit description beginning with a verb"

Modification codes

C -> Create U -> Update D -> Delete

Example:

git commit -m "server/ - U: Created user schema"

Developer environment

Environment files

At the root of /server and /client, make two environment files:

.env.production

.env.development

Client environment

Both files must contain values for the following keys:

• PORT=XXXX
• REACT_APP_WEBSOCKET_PORT=XXXX
• REACT_APP_SERVER_PORT=XXXX
• REACT_APP_GOOGLE_CLIENT_ID=X

Server environment

Both files must contain values for the following keys:

• DASHBOARD_SERVER_PORT=XXXX
• WEBSOCKET_PORT=XXXX
• JWT_SECRET="XXXX"
• RAPID_API_KEY="XXXX"
• CRYPTO_API_KEY="XXXX"
• UNSPLASH_ACCESS_KEY="XXXX"
• UNSPLASH_SECRET_KEY="XXXX"

Run development server:

cd ./server

npm run dev

Run development client:

cd ./client
npm run dev

Run production environment (mongodb + server + client + mongo-express)

At repository root:

docker-compose up -d --build

The development environment still needs the production environment to be running, because mongodb runs in the production container