https://github.com/kelsonbatista/project-api-typescript

Project API Typescript (Trybesmith)
https://github.com/kelsonbatista/project-api-typescript

api-rest msc typescript

Last synced: over 1 year ago
JSON representation

Project API Typescript (Trybesmith)

• Host: GitHub
• URL: https://github.com/kelsonbatista/project-api-typescript
• Owner: kelsonbatista
• Created: 2022-06-17T05:07:17.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-06-17T05:07:29.000Z (about 4 years ago)
• Last Synced: 2025-02-01T19:29:34.484Z (over 1 year ago)
• Topics: api-rest, msc, typescript
• Language: TypeScript
• Homepage:
• Size: 387 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# About the project / *Sobre o projeto*

This is a backend project about an API RESTful using MSC architecture (model-service-controller) in TYPESCRIPT and Classes. The API is CRUD system of products and orders, also login with token check.

*Esse é um projeto backend sobre uma API RESTful utilizando a arquitetura MSC (model-service-controller) em TYPESCRIPT e Classes. A API é um sistema CRUD de produtos e compras, também login com verificação por token.*

---

# Skills / *Habilidades*

 - TYPESCRIPT. *TYPESCRIPT*

 - API development. *Desenvolvimento de API*

 - MSC architecture (model-service-controller). *Arquitetura MSC (model-service-controller)*

 - Validation with JOI. *Validação com JOI*

 - Token generation with JWT. *Geração de Token com JWT.*

 - Better commits using commitLint, husky and commitizen. *Melhores commits utilizando commitLint, husky e commitizen*

---

# Endpoints / *Endpoints*

 - Login                  http://localhost:3000/login

 - Users (list all)       http://localhost:3000/users

 - Users (list by id)     http://localhost:3000/users/:id

 - Users (create)         http://localhost:3000/users

 - Users (update)         http://localhost:3000/users/:id

 - Users (delete)         http://localhost:3000/users/:id

 - Orders (list)          http://localhost:3000/orders

 - Orders (create)        http://localhost:3000/orders

 - Products (list)        http://localhost:3000/products

 - Products (list by id)  http://localhost:3000/products/:id

 - Products (create)      http://localhost:3000/products

 - Products (update)      http://localhost:3000/products/:id

 - Products (delete)      http://localhost:3000/products/:id

---

# Deployment / *Implantação*

 - docker-compose up -d --build    Start docker with Node and MySQL. *Inicia o docker com Node e MySQL*

 - docker exec -it trybesmith bash Enter in docker command line. *Entra na linha de comando do docker*

 - npm install                     Install all packages . *Instala todos os pacotes*

 - npm start                       Start api. *Inicia a api*