feat: improve readme file

Author: filipepacheco

.env.local

@@ -6,6 +6,8 @@ DB_DATABASE_NAME=sos_rs
 DB_USER=root
 DB_PASSWORD=root
 DATABASE_URL="postgresql://${DB_USER}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_DATABASE_NAME}?schema=public"
+; DATABASE_URL="postgresql://root:root@sos-rs-db:5432/sos_rs?schema=public"
+
 SECRET_KEY=batata
 
 HOST=::0.0.0.0

README.md

@@ -1,72 +1,111 @@
 # README para o Backend do App de Ajuda em Enchentes
 
-Este repositório contém o backend de um aplicativo desenvolvido para organizar e distribuir suprimentos, bem como coordenar voluntários durante os alagamentos no Rio Grande do Sul. O backend fornece APIs para autenticação de usuários, gerenciamento de abrigos e suprimentos, entre outros.
-
-## Sobre o Projeto
-
-O sistema backend é projetado para ser robusto e escalável, garantindo que possa lidar com o alto volume de acessos durante emergências. Ele opera com diversas APIs que permitem a interação com o frontend e outros serviços potenciais.
+Este repositório contém o backend de um aplicativo desenvolvido para organizar e distribuir suprimentos, bem como
+coordenar voluntários durante os alagamentos no Rio Grande do Sul. O backend fornece APIs para autenticação de usuários,
+gerenciamento de abrigos e suprimentos, entre outros.
 
 ## Tecnologias Utilizadas
 
 - **Node.js**: Ambiente de execução para JavaScript.
-- **Express**: Framework para aplicação web para Node.js.
-- **MongoDB**: Banco de dados NoSQL para armazenar dados de forma eficiente.
-- **JWT**: Para autenticação segura via tokens.
+- **Prisma**: ORM para Node.js e TypeScript.
+- **Docker**: Plataforma para desenvolvimento, envio e execução de aplicativos em contêineres.
+- **Nest**: Framework para aplicação web para Node.js.
+- **PostgreSQL**: Banco de dados NoSQL para armazenar dados de forma eficiente.
+
+## Dump do banco de dados
+
+Após toda a configuração feita, seja local ou via docker, você pode subir um dump do servidor para ter dados iniciais
+para testar a aplicação.
+O dump está disponível no arquivo `prisma/migration/dev_dump.sql`. Para subir o dump, basta executar ele.
+Lembrando que a migrations já deve ter sido rodada para ele funcionar.
+
+## Configuração com Docker
+
+Caso você esteja desenvolvendo frontend e não precise rodar uma instancia da API e do banco localmente, siga essas
+instruções:
+
+1. Clone o .env de exemplo:
+   ```bash
+   cp .env.local .env
+   ```
+
+2. Criar e iniciar o banco via docker. Esse comando irá subir um container com a API e outro container com o banco
+   Postgresql.
+   Além disso, ele também irá rodar as migrations do Prisma e terá um banco com o schema já configurado.
+
+    ```bash
+    docker-compose -f docker-compose.dev.yml up
+    ```
+
+Se você estiver tendo problemas para acessar o banco via um gerenciador (dbeaver, etc), pode ser preciso adicionar o
+port do serviço db no docker-compose.dev.yml
+
+```yaml
+ports:
+  - '5432:5432'
+  - '4000:4000'
+```
+
+Se você estiver recebendo algum erro relacionado a PORT da DATABASE_URL, tem uma linha comentada no .env que pode ser
+descomentada para resolver o problema.
 
-## Backlog
+## Configuração inicial para rodar localmente
 
-- [ ] **Importar abrigos**: Importar a lista de abrigos e suas necessidades em csv para facilitar integração com outros sistemas.
-- [ ] **Criar sistema de notificação**: Notificar em algum canal (whatsapp, discord, telegram) sobre atualizações.
+1. Clone o repositório:
+   ```bash
+   git clone https://github.com/seuusuario/projeto-enchentes-backend.git
+   ```
+2. Entre no diretório do projeto:
+   ```bash
+   cd projeto-enchentes-backend
+   ```
+3. Instale as dependências:
+   ```bash
+   npm install 
+   npx prisma generate 
+   npx prisma migrate dev 
+   npm run start:dev
+   ```
+4. Inicie o servidor:
+   ```bash
+   npm start
+   ```
+   A API estará acessível via `http://localhost:4000`.
 
 ## API Endpoints
 
 ### Usuários
+
 - **POST /users** - Cadastrar um novo usuário.
 - **PUT /users** - Atualizar um usuário existente.
 
 ### Sessões
+
 - **POST /sessions** - Criar uma nova sessão de usuário (login).
 - **GET /sessions/:sessionId** - Obter detalhes de uma sessão.
 - **PUT /sessions/:sessionId** - Atualizar uma sessão específica.
 
 ### Abrigos
+
 - **POST /shelters** - Cadastrar um novo abrigo.
 - **PUT /shelters/:shelterId** - Atualizar um abrigo existente.
 - **GET /shelters** - Listar abrigos.
 
 ### Suprimentos
+
 - **POST /supply** - Cadastrar um novo item de suprimento.
 - **PUT /supplies/:supplyId** - Atualizar um suprimento.
 - **GET /supplies** - Listar suprimentos.
 
 ### Categorias de Suprimentos
+
 - **POST /supply-categories** - Cadastrar uma nova categoria de suprimentos.
 - **PUT /supply-categories/:categoryId** - Atualizar uma categoria de suprimentos.
 - **GET /supply-categories** - Listar categorias de suprimentos.
 
-## Configuração Inicial
-
-1. Clone o repositório:
-   ```bash
-   git clone https://github.com/seuusuario/projeto-enchentes-backend.git
-   ```
-2. Entre no diretório do projeto:
-   ```bash
-   cd projeto-enchentes-backend
-   ```
-3. Instale as dependências:
-   ```bash
-   npm install
-   ```
-4. Inicie o servidor:
-   ```bash
-   npm start
-   ```
-   A API estará acessível via `http://localhost:4000`.
-
 ## Contribuição
 
-Contribuições são bem-vindas! Se quiser contribuir, por favor faça um fork do repositório, crie uma branch para suas modificações e depois envie um pull request.
-
+Contribuições são bem-vindas! Se quiser contribuir, por favor faça um fork do repositório, crie uma branch para suas
+modificações e depois envie um pull request.
 
 Sua participação é essencial para ajudarmos a comunidade afetada pelas enchentes no Rio Grande do Sul!

docker-compose.dev.yml

@@ -24,7 +24,7 @@ services:
       sh -c "npm install &&
       npx prisma generate &&
       npx prisma migrate dev &&
-      npm run start"
+      npm run start:dev"
   db:
     container_name: sos-rs-db
     image: postgres