BinaryStudioAcademy/bsa-winter-2022-2023-simpleland

SimpleLand

ℹ️ General Info

This is the repository responsible for SimpleLand's apps.

🏭 Applications

• Backend — SimpleLand's application backend.

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

• Frontend — SimpleLand's application frontend.

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

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

🖍 Requirements

• NodeJS (18.x.x);
• NPM (9.x.x);
• PostgreSQL (15.2)
• 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

1. npm install at the root
2. Fill ENVs
3. npx simple-git-hooks at the root
4. cd backend && npm run migrate:dev
5. cd frontend && npm run start:dev then cd backend && npm run start:dev
6. Enjoy <3

🏗 Architecture

🛖 Application Schema

💽 DB Schema

erDiagram

  users {
    int id PK
    dateTime created_at
    dateTime updated_at
    varchar email
    text password_hash
    text password_salt
  }

  %% mb user_details should content subscription_end_time col?
  user_details ||--|| users : user_id
  user_details ||--|| subscriptions : subscription_id
  user_details ||--|| files : avatar_id
  user_details {
    int id PK
    dateTime created_at
    dateTime updated_at
    int user_id FK
    varchar first_name
    varchar last_name
    varchar account_name "may be null if user didn't provide account name"
    int subscription_id FK "may be null if user don't have active subscription"
    int avatar_id FK "may be null if user didn't upload avatar"
  }

  sites {
    int id PK
    dateTime created_at
    dateTime updated_at
    varchar name
    varchar published_url "may be null if site was not published to specific domain"
    varchar image "may be null if OpenAI doesn't generate an image"
  }

  sections {
    int id PK
    dateTime created_at
    dateTime updated_at
    varchar name
    enum type "'header' | 'footer' | 'main'| 'portfolio' | 'about' | 'feedback' | 'service'"
    jsonb content
  }

  sites_to_sections }|--|| sections : section_id
  sites_to_sections }|--|| sites : site_id
  sites_to_sections {
    int id PK
    dateTime created_at
    dateTime updated_at
    int section_id FK
    int site_id FK
  }

  projects }o--|| users : user_id
  projects {
    int id PK
    dateTime created_at
    dateTime updated_at
    varchar name
    int user_id FK
    enum category "'e-commercial' | 'business' | 'blog' | 'portfolio' | 'personal' | 'nonprofit'"
  }

  projects_sites }|--|| projects : project_id
  projects_sites }|--|| sites : site_id
  projects_sites {
    int id PK
    dateTime created_at
    dateTime updated_at
    int project_id FK
    int site_id FK
  }

  subscriptions {
    int id PK
    dateTime created_at
    dateTime updated_at
    dateTime end_date
  }

  files {
    int id PK
    dateTime created_at
    dateTime update_at
    int url
  }

Loading

🌑 Backend

• Fastify — a backend framework.
• Knex — a query builder.
• Objection — 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.
• dangerjs — automate common code review chores.
• commitlint — helps your team adhere to a commit convention.
• 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.

🧑‍💻 CI

🗞 Git

🏅 Pull Request flow

<project-prefix>-<issue-number>: <ticket-title>

Example

• sl-5: Add Clinician Dashboard

🌳 Branch flow

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

Types

• task
• fix

Examples

• task/sl-5-add-clinician-dashboard
• task/sl-12-add-clinician-flow
• fix/sl-16-fix-clinician-flow

🗂 Commit flow

<project-prefix>-<issue-number>: <modifier> <description>

Modifiers

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

Examples

• sl-5: + title for dashboard
• sl-12: * dashboard title
• sl-16: - dashboard title

📦 CD

Handled by GitHub Actions.