Esta é uma API desenvolvida em Node.js com TypeScript, usando o Prisma ORM para interação com o banco de dados PostgreSQL. A API permite a criação e gerenciamento de eventos de Amigo Secreto, tanto para administradores quanto para usuários comuns. Ela inclui funcionalidades para realizar o sorteio do Amigo Secreto de forma automatizada.
Para instalar e executar esta API em seu ambiente local, siga as instruções abaixo:
- clone este repositório
git clone https://github.com/seu-usuario/api-amigo-secreto.git
- Instale as dependências usando npm ou yarn
npm install ou yarn install
- Instale as dependências usando npm ou yarn
npm install ou yarn install
- Configure as variáveis de ambiente:
Renomeie o arquivo .env.example para .env e preencha as variáveis de ambiente necessárias, como a URL do banco de dados PostgreSQL.
- Execute as migrações do prisma
npm prisma migrate dev
- Inicie o servidor
npm run dev
A API estará disponível em http://localhost:3000 por padrão, mas você pode configurar a porta no arquivo .env.
Este projeto utiliza a biblioteca Zod para validação de dados, garantindo que apenas dados válidos sejam aceitos pela API.
O banco de dados PostgreSQL é utilizado para armazenar os dados relacionados aos eventos de Amigo Secreto e aos participantes.