Projeto desenvolvido com instruções de Nathally Souza na trilha de estudo do Bootcamp "Inter Frontend Developer" da dio.me.
Link da base utilizada neste projeto: nathyts/api-dioshopping.
Abaixo seguem modificações feitas em relação ao projeto base:
- Foi alterado o banco de dados para PostgreSQL, o banco está hospedado em ElephantSQL com plano free;
- As informações de conexão foram colocadas em variáveis de ambiente no arquivo
.env
; - Criadas mensagens para
.then()
e.catch()
nocreateConnection()
do arquivodatabase/index.ts
; - Além do email e mensagem que já existiam, foi adicionado campo para "nome" na entidade
Message
; - Incluído na resposta da API o status code para informar se a requisição ocorreu normalmente (status 200) ou se foi gravado novo registro (status 201);
- Criada condicional para checar se email já foi utilizado que retornará o HTTP status code 403 - Forbidden caso realmente já foi usado;
- Criado endpoint para deletar mensagem, assim o cliente (frontend) pode apagar mensagens indevidas.
Observações para rodar o projeto baixado:
- Para instalar os arquivos de dependências do projeto, basta rodar o comando
yarn install
ounpm install
; - Para o repositório será disposto o arquivo
.env.example
com as variáveis de ambientes utilizadas pelo TypeORM para conexão com o banco, basta informar a url de conexão com o PostgreSQL na variávelTYPEORM_URL
e renomear o arquivo para.env
; - Para iniciar o servidor localmente, basta rodar o comando
yarn dev
ounpm run dev
.
- Confirmar se servidor está rodando:
GET
/
- Listar todas as mensagens:
GET
/message
- Criar/salvar nova mensagem:
POST
/message
- Deletar mensagem:
DELETE
/message/delete/{id}
Para testar localmente os Endpoints, foi adicionado ao projeto uma coleção do Postman que já possuí modelos e testes de requisições HTTP. O arquivo está na pasta postman
Projeto online pelo Heroku: api-dioshopping-didi.herokuapp.com/
- Repositório: didifive/dioshopping
- APP hospedada em: dioshopping-app.netlify.app