README.md

API de aluguel de carros desenvolvida durante o bootcamp Ignite da Rocketseat.

---

👨‍💻 Tecnologias utilizadas:

• Node.js (https://nodejs.org/en/)
• TypeScript (https://www.typescriptlang.org/docs/)
• Express.js (http://expressjs.com/)
• TSyringe (https://www.npmjs.com/package/tsyringe)
• BCrypt (https://www.npmjs.com/package/bcrypt)
• JWT (https://jwt.io/)
• Docker (https://docs.docker.com/)
• TypeORM (https://typeorm.io/#/)
• PostgreSQL (https://www.postgresql.org/)
• Babel (https://babeljs.io/)
• Nodemailer (https://nodemailer.com/about/)
• Jest (https://jestjs.io/)
• SuperTest (https://www.npmjs.com/package/supertest)
• Swagger (https://swagger.io/)
• Amazon AWS (https://aws.amazon.com/)
• Rate Limiter Flexible (https://www.npmjs.com/package/rate-limiter-flexible)
• Redis (https://redis.io/)
• Sentry (https://sentry.io/)

❗ Necessário para rodar o projeto

Docker e Docker Compose

✅ Passo a passo para rodar o projeto:

1. Clonar o repositório

git clone https://github.com/kaynansc/ignite_api

2. Criar os arquivos (.env e ormconfig.json) com base nos arquivos de exemplo (.env.example e ormconfig.example.json)

3. Levantar os containers (postgres e redis)

docker-compose up -d

4. Instalar dependências

npm install

5. Rodar as migrations

npm run typeorm migration:run

6. Rodar a aplicação

npm run dev

📃 Documentação

• Verifique a documentação do swagger localmente em: http://localhost:3333/api-docs

📄 License

This project is under MIT license. See the LICENSE file for more details.