JosuerBague/bsa-2023-bsa-talents

BSA Talents

ℹ️ General Info

This is the repository responsible for BSA Talents apps.

🏭 Applications

• Backend — BSA Talents application backend.

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

• Frontend — BSA Talents application frontend.

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

• Mobile — BSA Talents application mobile.

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

• Shared — BSA Talents application common modules for reuse.

🖍 Requirements

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

💽 DB Schema

erDiagram

  users {
      varchar id PK
      dateTime created_at
      dateTime updated_at
      citext email
      enum role "talent employer admin"
      text password_hash

   }

  user_details ||--|| users : user_id
  user_details ||..|o files : photo_id
  user_details ||..|o files : company_logo_id
  user_details ||..|o files : cv_id
  user_details {
      varchar id PK
      dateTime created_at
      dateTime updated_at
      varchar user_id FK
      boolean is_approved
      varchar denied_reason
      boolean is_hired
      varchar profile_name
      int salary_expectation
      int hired_salary
      varchar job_title
      varchar location
      decimal experience_years
      text[] employment_type
      text description
      varchar english_level
      text[] not_considered
      text[] preferred_languages
      text[] project_links
      varchar photo_id FK
      varchar full_name
      varchar phone
      varchar linkedin_link
      varchar company_name
      varchar company_logo_id FK
      varchar company_website
      varchar employer_position
      varchar cv_id FK
      enum completed_step "profile bsa-badges skills-and-projects cv-and-contacts preview"
      dateTime published_at
      enum search_type "active passive"
   }

  files {
      varchar id PK
      dateTime created_at
      dateTime update_at
      varchar url
      varchar etag
      varchar file_name
  }

  hard_skills{
      varchar id PK
      dateTime created_at
      dateTime update_at
      varchar name
  }

  talent_hard_skills }|..|o user_details : user_details_id
  talent_hard_skills }|..|| hard_skills : hard_skill_id
  talent_hard_skills{
      varchar id PK
      dateTime created_at
      dateTime update_at
      varchar user_details_id FK
      varchar hard_skill_id FK
  }

  bsa_badges{
      varchar id PK
      dateTime created_at
      dateTime update_at
      varchar name
      varchar type
      int max_score
  }

  talent_badges }|--|| users : user_id
  talent_badges }|--|o user_details : user_details_id
  talent_badges }|--|| bsa_badges : badge_id
  talent_badges{
      varchar id PK
      dateTime created_at
      dateTime update_at
      int score
      varchar level
      boolean is_shown
      varchar user_id FK
      varchar user_details_id FK
      varchar badge_id FK
  }

  chat_messages ||--|| user_details : user_id
  chat_messages{
      varchar id PK
      dateTime created_at
      dateTime update_at
      text message
      varchar sender_id FK
      varchar receiver_id FK
      varchar chat_id
      boolean isRead
  }

🏃‍♂️ 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 then npm run start:dev
5. cd frontend && npm run start:dev
6. Enjoy ❤️

🌑 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.

🏅 Pull Request flow

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

Example

• bt-5: Add auth

🌳 Branch flow

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

Types

• task
• fix

Examples

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

🗂 Commit flow

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

Modifiers

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

Examples

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

📦 CI/CD

CI/CD implemented using GitHub Actions