AniList API

Avalie e veja a opnião de outras pessoas sobre seus animes favoritos

Trello | Docs

AniList é uma plataforma inspirada no My Anime List a qual foi contruída para aprimorar minhas habilidade em NodeJs, NestJs, APIs e código limpo, além de aprender como processar dados em filas (processamento de imagens e envio de e-mails), testes unitários e diferentes níveis de permissão e autenticação.

Tabela de Conteúdos

• Tecnologias
• Instalação e configuração
  • Requisitos
  • Instalação
• Licença

Tecnologias

Este projeto foi construído com as seguintes tecnologias:

• Node.js »
• Nest.js »
• Typescript »
• Jest »
• GitHub Actions »
• Swagger »
• TypeORM »
• Redis »

Instalação e configuração

Requisitos

• Node.js » na sua versão LTS
• Um Banco de dados suportado pelo TypeORM »
• Um Banco de dados Redis »

Instalação e inicialização

1. Clone o projeto: git clone https://github.com/JorgeLNJunior/AniList-API.git
2. Instale as dependências: npm i
3. Renomeie o arquivo .env.example para .env
4. Para iniciar a aplicação execute npm run build e npm run start:prod
5. Para iniciar um container docker execute npm run docker:build e npm run docker:run
6. Para os testes execute npm test

Licença

Projeto sob a licença MIT »