vitaliibedletskyi / backend-starter

BSA-2022 | Streamlet

ℹ️ General Info

This is the repository responsible for Streamlet's apps.

🏭 Applications

• Backend — Streamlet's application backend.

  To work properly, fill in the .env file. Use the .env.example file as an example.

• Frontend — Streamlet's application frontend.

  To work properly, fill in the .env file. Use the .env.example file as an example.

• Shared — Streamlet's application common modules for reuse.

🖍 Requirements

• NodeJS (16.x.x);
• NPM (8.x.x);
• PostgreSQL (14.0)
• Docker
• run npx simple-git-hooks at the root of the project, before the start (it will set the pre-commit hook for any commits).

🏃‍♂️ Simple Start

Setup database

1. Create .env folder at the root project and add api-db.env file according to .env.example

Setup apps

1. Fill ENVs in each project
2. npm install at the root
3. npx simple-git-hooks at the root

Run project

Each project run in the separate terminal

1. Go to .docker folder and run: docker compose up -d
2. Apply first migration to DB: npm run migrate
3. Run: npm run start:backend
4. Run: npm run start:frontend

Code Quality

Static analyzers are used for both frontend and backend projects to ensure basic code quality. Additionally, quality criteria rules are enforced during code review and audit.

Architecture

💽 DB Schema

erDiagram
  users {
      string id
      string email
      string  password
      boolean isActivated
      dateTime created_at
      dateTime updated_at
  }

Loading

🧑‍💻 CI

🗜 Tools

🌑 Backend

• Express – a backend framework.
• InversifyJS - an IoC container
• Prisma – an ORM.

🌕 Frontend

• React – a frontend library.
• Redux + Redux Toolkit – a state manager.

🥊 Code quality

• simple-git-hooks — a tool that lets you easily manage git hooks.
• lint-staged — run linters on git staged files.
• editorconfig — helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs.
• prettier — an opinionated code formatter.
• ls-lint — file and directory name linter.
• eslint – find problems in your JS code
• stylelint – Find and fix problems in your CSS code

🗞 Git

📊 Branches

• production - production source code.
• development - staging source code.

🌳 Branch flow

<type>/<project-prefix><ticket-number>-<short-desc>

Types:

• task
• fix

Examples:

• task/design5-add-signin-page
• task/blog12-add-filters
• fix/design16-fix-signup-validation

🗂 Commit flow

<project-prefix>-<ticket-number>: <modifier> <desc>

Modifiers:

• + (add)
• * (edit)
• - (remove)

Examples:

• blog-5: + form component
• design-12: * filter markup
• blog-16: - require prop for nickname field

📦 CD

Handled by GitHub Actions.