Sobre o projeto

No projeto é abordado conceitos importantes sobre o mundo do backend.

Tem conceitos como:

  • Endpoints
  • Controllers
  • Banco de dados SQL
  • Query builder
  • Migrations de banco
  • Seeds de banco
  • Controle de usuário com email e senha
  • Criptografia de senha
  • Login de usuários
  • Geração e utilização de tokens JWT
  • Validação minuciosa de dados que entram nos endpoints
  • Paginação de consultas
  • Filtros de consultas
  • Testes de código para garantir qualidade das entregas
  • Uso de diferentes bancos de dados com um mesmo código
  • Boas práticas de código, com conceitos do clean code

Como rodar

Você vai precisar do nodens instalado no seu computador para rodar o projeto.

Clone o repositório:

$ git clone https://github.com/samuelrms/rest-api-study-with-node-typescript.git

Entre na pasta

$ cd rest-api-study-with-node-typescript

Instale as dependências

$ yarn install

Configure as variáveis ambiente, crie o arquivo .env na pasta raiz do projeto coloque o conteúdo a seguir dentro

PORT=7777
NODE_ENV=dev

Rode o projeto

$ yarn start

EndPoints

  • Base url
api-rest-types-xheh3.ondigitalocean.app

Cidades

api-rest-types-xheh3.ondigitalocean.app/cities
  • Create
  • Delete
  • Put
  • Post
  • Filters & Limit