erickssguerra/poc-typescript

POC - Typescript - DrivenFit

• In this back-end project, a simple system of a Gym is used as a Proof of concept (POC) of TypeScript coding.
• A CRUD (Create, Update and Delete) protocol was used for manage two self-explained tables: customers and enrollments.
• The table courses (with gym courses in Portuguese) is already created in the database;
• Furthermore, ranking routes are implemented, aggregating the courses and customers metrics (see routes below).

👣 Initial steps

Install all dependencies

npm i 

Create the .env file following the .env.example file in the root folder

• Example of .env file:

POSTGRES_USERNAME= 
POSTGRES_PASSWORD= 
POSTGRES_HOST= 
POSTGRES_PORT= 
POSTGRES_DATABASE= 

PORT=

Run the server API locally

npm run dev

Build the application (for deploy)

npm run build

Start the application (for deploy)

npm run start

⚠️ You'll also need to download the database structure (see database section below)

🗂 Folders organization

├── README.md
├── package-lock.json
├── package.json
├── 📁 src
│   ├── 📁 controllers
│   │   ├── courses.controllers.ts
│   │   ├── customers.controllers.ts
│   │   └── enrollments.controllers.ts
│   ├── 📁 database
│   │   ├── connectionDB.ts
│   │   ├── dbdiagram.png
│   │   └── dump.sql
│   ├── index.ts
│   ├── 📁 middlewares
│   │   ├── courses.middlewares.ts
│   │   ├── customers.middleware.ts
│   │   └── schemas.validation.ts
│   ├── 📁 protocols
│   │   ├── courses-rank.ts
│   │   ├── customer.ts
│   │   ├── customers-rank.ts
│   │   └── enrollment.ts
│   ├── 📁 repositories
│   │   ├── courses.repository.ts
│   │   ├── customers.repository.ts
│   │   └── enrollments.repository.ts
│   ├── 📁 routes
│   │   ├── courses.routes.ts
│   │   ├── customers.routes.ts
│   │   ├── enrollments.routes.ts
│   │   └── index.ts
│   ├── 📁 schemas
│   │   ├── customer.schema.ts
│   │   ├── enrollment.schema.ts
│   │   └── top-query.schema.ts
│   └── 📁 services
└── tsconfig.json

🧭 Routes

Customers routes

👉🏻 Registering a customer

• POST /register
• Send customer via body as follow

{
    "name": "Customer Name",
    "email": "test@test.com",
    "cpf": "12345678910"
}

• If succeed, receive an answer in the format:

{
    "message": "Customer_name was registered!"
}

👉🏻 Updating a customer's email

• PUT /update/email
• Send the infos via body as follow

{
    "new_email": "new_email@example.com",
    "previous_email": "previous_email@example.com"
}

• If succeed, receive an answer in the format:

{
    "message": "Customer_name's email updated!"
}

Enrolments routes

👉🏻 Enrolling a customer in a course

• POST /enroll
• Send a body containing the following infos

{
    "customer_id": "1",
    "course_id": "2"
}

• If succeed, receive an answer in the format:

{
    "message": "Success: Customer_X was enrolled into Course_X!"
}

👉🏻 Unenrolling a customer from a course

• DELETE /enroll
• Send a body containing the following infos

{
    "customer_id": "1",
    "course_id": "2"
}

• If succeed, receive an answer in the format:

{
    "message": "Success: Customer_X was unenrolled from Course_X!"
}

👉🏻 Rank of customers with higher number of enrolements

• GET /rank/customers
• Optional a query top with a number, as the example below:

/rank/customers?top=3

• Response in the format:

[
  {
    "customer": "Érick",
    "courses": "5"
  },
  {
    "customer": "Brun0",
    "courses": "4"
  },
  {
    "customer": "Jader",
    "courses": "3"
  }
]

Courses routes

👉🏻 Rank of courses with higher number of enrollments

• GET /rank/courses
• Optional a query top with a number, as the example below:

/rank/courses?top=3

• Response in the format:

[
  {
    "course": "LPO",
    "customers": "7"
  },
  {
    "course": "Dança",
    "customers": "5"
  },
  {
    "course": "Zumba",
    "customers": "3"
  }
]

👉🏻 Courses that a customer is enrolled in

• GET /courses/:customer_id
• customer_id is a number and required, as the example below:

/courses/2

• Response in the format of an array, as shown below:

[
  "Spining",
  "Funcional",
  "Dança",
  "LPO",
  "Hidroginástica"
]

🗄️ Database

Database structure

Database dump

• Dump file