readme.md
August 18, 2021 ยท View on GitHub
๐ง Jabber ๐ช
โน๏ธ General info
This is the repository responsible for Jabber's app.
๐ Requirements:
- NodeJS (14.x.x);
- NPM (6.x.x);
- PostgreSQL (13.x);
- run
npx simple-git-hooksat the root of the project, before the start (it will set the pre-commit hook for any commits).
Code quality
Static analyzers are used for all projects to ensure basic code quality. Additionally, quality criteria rules are enforced during code review and audit.
๐ Shared
This folder contains all common (helpers, enums and etc.) stuff for other applications (backend, frontend and etc.).
โ๏ธ BackEnd
For the BackEnd to work properly, you need to fill in the .env file. You can use the .env.example file as an example.
๐ก FrontEnd
For the FrontEnd to work properly, you need to fill in the .env file. You can use the .env.example file as an example.
๐โโ๏ธ Simple start
npm run install:allat the root- Fill ENVs
npx simple-git-hooksat the rootnpm run start:devat the root- Enjoy <3