EduPrime.core Project

Para iniciar o projeto, crie um arquivo .env com essa estrutura:

POSTGRES_DB=apiprimedb
POSTGRES_USER=eduprimedb
POSTGRES_PASSWORD=edu@2025@password
POSTGRES_HOST=localhost
POSTGRES_PORT=5432
POSTGRES_SCHEMA=public

DATABASE_URL="postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}?schema=${POSTGRES_SCHEMA}"

E depois execute o comando:

pnpm run docker:start

Este é o README para o projeto EduPrime.core, que utiliza a extensão vscode-restclient para Visual Studio Code.

Sobre a extensão vscode-restclient

A extensão vscode-restclient é uma ferramenta poderosa para testar e depurar APIs diretamente no VSCode. Ela permite enviar requisições HTTP personalizadas e visualizar as respostas de forma fácil e intuitiva. Com recursos como autenticação, cabeçalhos personalizados e suporte para múltiplas requisições, essa extensão é essencial para desenvolvedores que trabalham com APIs.

Tecnologias utilizadas

O projeto EduPrime.core utiliza as seguintes tecnologias:

• NestJS: um framework para construir aplicações server-side com Node.js. Ele fornece uma arquitetura modular e escalável, facilitando o desenvolvimento de APIs robustas.

• Prisma: um ORM (Object-Relational Mapping) moderno e poderoso para Node.js. Ele simplifica a interação com o banco de dados, permitindo que os desenvolvedores escrevam queries em TypeScript.

• Fastify: um framework web rápido e eficiente para Node.js. Ele é conhecido por sua velocidade e baixo consumo de recursos, tornando-se uma ótima escolha para construir APIs de alto desempenho.

Gerador de CRUD

Utilizamos o gerador de CRUD do nestjs-prisma-crud para agilizar o desenvolvimento de operações básicas no banco de dados. Este gerador permite criar rapidamente endpoints para operações CRUD (Create, Read, Update, Delete) com base nos modelos do Prisma.

Como executar o projeto

Siga os passos abaixo para executar o projeto EduPrime.core:

1. Clone este repositório para o seu ambiente local.

2. Instale as dependências do projeto executando o comando:

   pnpm install

3. Configure suas variáveis de ambiente no arquivo .env com a URL de conexão ao seu banco de dados PostgreSQL. Um exemplo de configuração de URL de conexão pode ser:

   DATABASE_URL="postgresql://user:password@localhost:5432/eduprime"
   

4. Inicie os serviços do Docker executando o comando:

   pnpm run docker:start

5. Gere o cliente Prisma e aplique as migrações ao banco de dados executando os seguintes comandos:

   pnpm prisma generate
   pnpm prisma migrate dev

6. Popule o banco de dados com dados iniciais executando o comando:

   pnpm run seed

7. Inicie o servidor executando o comando:

   pnpm run start

8. Abra o VSCode e instale a extensão vscode-restclient.

9. Abra o arquivo requests.http na pasta src para visualizar e executar as requisições de exemplo.

Como popular o banco de dados

Para popular o banco de dados com dados iniciais, siga os passos abaixo:

1. Resetar o banco de dados (este comando apagará todos os dados existentes e aplicará as migrações):

   pnpm prisma migrate reset

2. Rodar o script de seed para adicionar dados iniciais ao banco de dados:

   pnpm run seed

O comando pnpm prisma migrate reset limpará o banco de dados, aplicará novamente todas as migrações e executará o script de seed configurado, populando o banco de dados com os dados iniciais.

Contribuição

Contribuições são bem-vindas! Se você encontrar algum problema ou tiver alguma sugestão, sinta-se à vontade para abrir uma issue ou enviar um pull request.

Licença

Este projeto é licenciado sob a Licença MIT.