sandromancuso/cleancoders_openchat_webclient

Openchat

Dependencies

You need to have installed the node version specified on .nvmrc and yarn.

To manage node versions, it is recommended to use a version manager like nvm on linux or n on macOS.

To install the project dependencies you need to use yarn install.

If you are in mac, additionaly run brew install watchman to be able to use a watcher in the tests.

Environments

You have the environment variables on .env, you can change them to suit your needs.

If you need more environments, check the documentation.

Development server

Run yarn start for a development server.

Running unit tests

Run yarn test to execute every test.

Run yarn unit to execute unit tests.

Run yarn integration to execute integration tests.

Linting

You can test for linting issues with yarn lint.

Some issues can be automatically fixed with yarn lint --fix.

Git hooks

This project is using git hooks before certain actions.

If you want to punctually disable it, you can use the flag --no-verify

e.g. git push --no-verify.

Build

You can run yarn build to build the project. The build artifacts will be stored in the dist/ directory.