Skip to content

LITA-CODERS/Lita-back-end-rest-api

Repository files navigation

🔺 LITA-API-REST 🔺

📕 Índice


Sobre

📡 API Rest da loja lita, desenvolvida com as melhores práticas do mercado, pensando em ser uma aplicação totalmente escálavel e desacacoplada, tornando fácil sua manutenção e adição de features novas.

Tecnologias


Iniciando

Pré-requisitos
  • Node JS

    https://nodejs.org/en/
  • Yarn ou Npm

    https://yarnpkg.com/
  • PostgresSQL

    https://www.postgresql.org/

Instalação e uso

# Execute este comando para clonar o projeto
$ git [email protected]:LITA-CODERS/Lita-back-end-rest-api.git
# ou use a opção de download.

# Entre na pasta com
$ cd Lita-back-end-rest-api

# Instale as dependências
$ yarn ou npm install

# Crie o banco de dados e as tabelas utilizando o comando
$ yarn typeorm migration:run ou npm typeorm migration:run

# Rode a aplicação usando o comando
$ yarn dev ou npm run dev

# Para rodar os testes execute este comando
$ yarn test ou npm test

👷🏿 Testes automatizados 👷🏿

Por fim de garantir o funcionamento correto de todas as funcionalidades da aplicação, foi realizado testes unitários e de integrações utilizando o Jest, todos os testes se encontram dentro da pasta tests presentes em seu respectivo useCase, resultados obtidos foram quase 100% de cobertura nos testes faltando bem pouco para isto.

👨🏽‍🚀 Deploy

Heroku: https://github.com/LITA-CODERS/Lita-back-end-rest-api/deployments/activity_log?environment=lita12

💁🏿‍♂️ Notas do desenvolvedor

  • Foi pensando em um sistema de autenticação, que inclusive esta todo em funcionamento, só não foi implementado no front pelo tempo curto
  • Todo o projeto foi desenhado para ser o mais limpo possível utilizando conceitos de SOLID e CLEAN CODE, visando qualidade do código, também esta sendo utilizando o repository pattern.
  • Plataforma escolhida para o deplou foi o heroku, pela praticidade que ela nós entrega.

Licença

Distribuído sob a licença MIT. Veja LICENSE para mais informações.

Contatos


@WelissonLuca

@mimaganin

About

Back end da aplicação desenvolvida para a loja Lita

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages