| ... | ... | @@ -27,6 +27,106 @@ Para executar o Frontend do projeto, é necessário instalar: |
|
|
|
|
|
|
|
Após a instalação do Node.js, verifique se ele foi instalado corretamente executando o seguinte comando no terminal:
|
|
|
|
|
|
|
|
```sh
|
|
|
|
```bash
|
|
|
|
node -v
|
|
|
|
``` |
|
|
\ No newline at end of file |
|
|
|
```
|
|
|
|
</details>
|
|
|
|
|
|
|
|
## Backend
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary><strong>Configuração do Ambiente Backend</strong></summary>
|
|
|
|
|
|
|
|
### Requisitos
|
|
|
|
|
|
|
|
Certifique-se de ter as seguintes ferramentas instaladas na sua máquina:
|
|
|
|
|
|
|
|
- [Node.js v22.14.0](https://nodejs.org/en)
|
|
|
|
- [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable)
|
|
|
|
- [Docker + Docker Compose](https://www.docker.com/products/docker-desktop)
|
|
|
|
- [Git](https://git-scm.com/)
|
|
|
|
|
|
|
|
Verifique se tudo foi instalado corretamente:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
node -v
|
|
|
|
yarn -v
|
|
|
|
docker -v
|
|
|
|
git --version
|
|
|
|
```
|
|
|
|
|
|
|
|
### Instalação
|
|
|
|
|
|
|
|
Clone o repositório e acesse a pasta do projeto:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
git clone https://tools.ages.pucrs.br/lobo-guara/backend.git
|
|
|
|
cd backend
|
|
|
|
```
|
|
|
|
|
|
|
|
Instale as dependências:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
yarn install
|
|
|
|
```
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Banco de Dados
|
|
|
|
|
|
|
|
Suba o container do banco de dados com Docker Compose:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
docker-compose up -d
|
|
|
|
```
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Variáveis de Ambiente
|
|
|
|
|
|
|
|
Crie um arquivo `.env` na raiz do projeto com o seguinte conteúdo:
|
|
|
|
|
|
|
|
```env
|
|
|
|
DATABASE_URL="postgresql://postgres:postgres@localhost:5432/loboguara"
|
|
|
|
SECRET_KEY="sua_chave_secreta"
|
|
|
|
MAILERSEND_API_KEY="sua_api_key"
|
|
|
|
MAILERSEND_FROM_EMAIL="[email protected]"
|
|
|
|
```
|
|
|
|
|
|
|
|
> ℹ️ Consulte a equipe para obter os valores reais de `SECRET_KEY` e `MAILERSEND_API_KEY`.
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Migrações
|
|
|
|
|
|
|
|
Rode as migrações do banco de dados:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
yarn prisma migrate deploy
|
|
|
|
```
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Execução
|
|
|
|
|
|
|
|
Para iniciar a aplicação em modo de desenvolvimento:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
yarn start:dev
|
|
|
|
```
|
|
|
|
|
|
|
|
A API estará disponível em:
|
|
|
|
|
|
|
|
- Swagger: http://localhost:3000/docs
|
|
|
|
- Base URL: http://localhost:3000
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Parando os Containers
|
|
|
|
|
|
|
|
Para parar os containers do banco de dados:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
docker-compose stop
|
|
|
|
```
|
|
|
|
</details> |
|
|
\ No newline at end of file |
