luckymadu/ghibli-50-api

Ghibli.50 API é uma API desenvolvida com o objetivo de cadastrar os filmes do studio Ghibli no banco de dados e retornar essa informação de forma paginada para o cliente solicitante. A API está com deploy ativo na Vercel e o banco de dados na Railway.

Ghibli.50 API

Projeto   |    Tecnologias   |    Serviços Utilizados   |    Começando   |    Como utilizar   |    Features   |    Licença

💻 Projeto

Ghibli.50 API é uma API desenvolvida com o objetivo de cadastrar os filmes do Studio Ghibli no banco de dados e retornar essa informação de forma paginada para o cliente solicitante.

🚀 Tecnologias

O projeto foi desenvolvido utilizando estas tecnologias:

• Node.js
• TypeScript
• Express
• Prisma
• PostgreSQL
• Swagger

👨‍🔧 Serviços utilizados

• Swagger
• Ghibli API

🎮 Começando

Se possui interesse em executar o código, comece clonando o repositório utilizando o método HTTP ou SSH Key

• Abra seu git bash
• Digite git clone
• Insira o HTTP or SSH key (no windows, shift + insert para colar no terminal do gitBash)
• Você pode encontrar o HTTP ou SSH Key deste porjeto clicando em Code no canto direito superior deste repositório

Abordagem 1: Docker

• Abordagem mais prática que dispensa instalação das ferramentas, basta possuir o Docker / Docker Compose instalado na máquina. Após clonar o projeto execute os comandos abaixo:
• docker compose up -d -> Para gerar a imagem da API e baixar a imagem do PostgreSQL no Docker. A flag -d fará com que os containers continuem executando em segundo plano;
• docker exec -it ghibli-50-api /bin/bash -> Para acessar a linha de comando do container ghibli-50-api;
• npx prisma migrate dev -> Para criar as tabelas no banco de dados;
• Acesse http://localhost:3333/ para visualizar a documentação;

Abordagem 2: Executar localmente

• O projeto utiliza como banco de dados em desenvolvimento o PostgreSQL. É necessário possuir o banco de dados instalado na máquina para que o projeto funcione conforme esperado
• Ao instalar o PostgreSQL, abra o pgAdmin4
  
• Assim que abrir o app pgAdmin4 será solicitado uma senha. Essa é a senha que foi criada no momento da instalação do postgres.
  PS: A versão que estou utilizando é a 15x, windows, portanto pode haver alguma diferença a depender do SO e da versão do postgresql instalada
  
• Em seguida, clique em Server. Será solicitado novamente a senha
  
• Depois de inserir a senha será exibido o conteúdo do PostgreSQL. Clique com o botão direito sobre Databases, em seguida passe o mouse por Create e selecione a opção Database
  

• Digite o nome do banco de dados de sua preferência. Guarde essa informação, ela deverá ser utilizada no arquivo .env como variável de ambiente em DATABASE_URL
• Depois de clonado e com o PostgreSQL configurado, abra o projeto na sua IDE e crie um arquivo .env na raiz do projeto.
  
• Insira uma chave com o nome de DATABASE_URL e adicione o endereço do banco de dados criado no postgres no seguinte formato:
  

• postgresql://USER:PASSWORD@HOST:PORT/DATABASE -> Referência: Prisma Database Connectors
  

Dependências

• Express
• Axios
• Prisma
• Swagger-ui-express

Dependências de desenvolvimento

• Typescript
• tsx

📌 Como utilizar

npm install Para instalar as dependências do projeto

npx prisma migrate dev Para criar a tabela de Filmes no banco de dados

npm run dev Para executar o app em desenvolvimento

É possível utilizar o Insomnia (ou outra ferramenta similar) para testar as rotas da aplicação.

🕵 Features

As principais features dessa aplicação são:

• Adicionar os filmes do Studio Ghibli na API (limitado a 50)
• Listar os filmes de forma paginada, de 10 em 10
• A documentação da API está disponível em https://ghibli-50-api.vercel.app/

📝 Licença

Este projeto está sobre a licença ISC.

No caso de bugs sensíveis como vunerabilidades de segurança, por gentileza entre em contato com [email protected] direto ao invés de utilizar as issues. Valorizamos seu esforço em melhorar a segurança e a privacidade deste projeto!

---

Por favor, siga no github! Obrigado pela visita e mão na massa!

Feito com ♥ por Deywerson Pereira