API REST - NODE E TYPESCRIPT

Este projeto é uma API Rest em NodeJS e Typescript desenvolvida para fins de aprendizado no curso API Rest em NodeJS e Typescript do canal Lucas Souza Dev no YouTube.

---

📍 Visão Geral

Objetivo

Meu principal objetivo é entender o funcionamento básico do backend para ter uma visão mais clara do fluxo das aplicações. Além disso, isso tem sido um ótimo ponto de partida para a implementação de testes unitários.

Motivação

Minha motivação é me tornar uma desenvolvedora cada vez mais completa, capaz de resolver problemas cada vez mais complexos.

---

🧬 Funcionalidades

• Capacidade de operar com diferentes sistemas de banco de dados usando o mesmo código.
• Seeds: Inserção inicial de dados para facilitar testes e desenvolvimento.
• Migrations: estruturas para gerenciar alterações no esquema do banco.
• Autenticação de usuários com e-mail e senha.
• Validação rigorosa de dados em endpoints.
• Geração e uso de tokens JWT.
• Paginação de resultados.
• Criptografia de senhas.
• Filtros de consultas.
• Testes de código.

---

🚀 Começando

⚙️ Instalação

❯ git clone git@github.com:jessicasantosb/api-rest.git

❯ cd api-rest

❯ yarn

❯ yarn dev

---

🤖 Uso

Variáveis de Ambiente

Crie o arquivo .env na raiz do projeto e adicione as seguintes variáveis:

❯ PORT=<your_key>
❯ NODE_ENV=<your_key>
❯ IS_LOCALHOST=<your_key>
❯ JWT_SECRET=<your_key>

Adicione as variáveis do banco de dados:

❯ DATABASE_HOST=<your_key>
❯ DATABASE_USER=<your_key>
❯ DATABASE_NAME=<your_key>
❯ DATABASE_PASSWORD=<your_key>
❯ DATABASE_PORT=<your_key>

---

🧪 Teste Unitário

❯ yarn test

---

💻 Tecnologias

• Typescript
• NodeJS
• Yup
• BcyrptJS
• JSONWebToken
• Knex
• Jest
• Sqlite3
• Postgre

---

🤝 Contribuições

• 🔰 Mencione quaisquer problemas conhecidos ou limitações.
• 🐛 Esboce seus planos para melhorias futuras.