Sobre • Repositories API • Instalação • Tecnologias • Autor
Projeto proposto no desafio complementar do módulo I da trilha do bootcamp de NodeJS da Rocketseat cujo objetivo foi identificar erros em uma API de template para colocar em pratica os ensinamentos do módulo e praticar o debugging de códigos.
Essa API é um CRUD de repositórios de projetos e o intuito dela foi servir como base pra pratica de debugging e correção de erros.
O template da API foi entregue no desafio complementar do módulo I do curso com diversos erros e trechos de códigos ausentes para que, após investigação e debugging da API, todos os erros fossem corrigidos e a aplicação estivesse totalmente funcional.
A API é bem simples e possui as rotas abaixo:
GET /repositories
A rota retorna uma lista contendo todos os repositórios cadastrados.
POST /repositories
A rota recebe
title, url e techs pelo corpo da requisição e retorna um objeto com as informações do repositório criado e um status 201.
PUT /repositories/:id
A rota recebe
title, url e techs pelo corpo da requisição e o id do repositório que deve ser atualizado pelo parâmetro da rota. Altera apenas as informações recebidas pelo corpo da requisição e retorna esse repositório atualizado.
DELETE /repositories/:id
A rota recebe, pelo parâmetro da rota, o
id do repositório que deve ser excluído e retorna um status 204 após a exclusão.
POST /repositories/:id/like
A rota recebe, pelo parâmetro da rota, o
id do repositório que deve receber o like e retornar o repositório com a quantidade de likes atualizada.
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js. Além disso é bom ter um editor para trabalhar com o código como VSCode.
# Clone este repositório
$ git clone [email protected]:MrRioja/todos-ignite-correcting-code.git
# Acesse a pasta do projeto no terminal/cmd
$ cd todos-ignite-correcting-code
# Instale as dependências
$ npm install
# Caso prefira usar o Yarn execute o comando abaixo
$ yarn
# Execute a aplicação em modo de desenvolvimento
$ npm run dev
# Caso prefira usar o Yarn execute o comando abaixo
$ yarn dev
# Execute os testes da aplicação
$ npm run test
# Caso prefira usar o Yarn execute o comando abaixo
$ yarn test
# O servidor inciará na porta 3333 - acesse <http://localhost:3333>
