Conva

You can use npm run commit to commit your changes in a procedural way. See below.

Environment

Before starting development, for first time setup.

Local SSL

Generate local SSL key & certificate. Refer this for mkcert.

mkcert localhost

Variables Setup

• Client env variables are already present in client directory in .env.* files. You can change them manually if you need to.

• Server env variables load from .env file at root.

Automatic

npm run env

Follow the CLI to generate local .env file at root of project automatically.

Manual

Create a .env file in the root of project, copy contents from .sample.env, and set the values as per your development requirements.

Install packages

npm install -g create-react-app # global client initializer
npm install # server packages
npm run install:client # client packages

Development

Run client & server concurrently

npm run dev # client & server localhost

By default, Backend at port: 5000, Frontend at port: 3000

Run only server

npm run server

Run only client

npm run client

Testing

Full application auto testing

npm run test:full

Backend Unit Testing

npm test

Frontend Unit Testing

For interactive testing

npm run test:client

For automatic testing

npm run test:client:auto

Contributing

Refer package.json for more npm scripts.

npm run commit

Use the above command to locally run unit tests, build linting & committing changes. By doing so, you'll save the time spent by remote action workflow to run tests & builds, and you won't have to revert your commit if tests fail, as this will raise any warnings or errors that occur, before commiting your changes.

CI & CD

• Any commits on branch:main trigger production build, test & deployment workflows for both front & backend, depending upon code changes.

• Any commits on branch:beta trigger beta build, test & deployment workflow, currently for frontend only (if backend side code changes are detected, the respective backend production deployment workflow also triggers from this branch). If you've made changes over this branch for frontend, then a temporary beta preview url will be displayed in the respective action workflow logs, valid for 15 days.

• Any pull requests to branch:main triggers respective workflows for build & test.

Footnotes

• It is highly recommended that npm run commit is used to commit your contributory changes.

• Actions workflow is enabled for commits on main branch, therefore tests, builds and deploys are automated from this branch.

• Actions workflow is enabled for pull requests for build and test.