readme.md

August 18, 2021 ยท View on GitHub

๐ŸŽง Jabber ๐Ÿช—

Mobile app repository

โ„น๏ธ 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-hooks at 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

  1. npm run install:all at the root
  2. Fill ENVs
  3. npx simple-git-hooks at the root
  4. npm run start:dev at the root
  5. Enjoy <3