Merge branch 'develop' into tooling/ci-improvement

Author: sombraSoft

.env.example

@@ -5,7 +5,7 @@ DB_PORT=
 DB_USER=
 DB_PASSWORD=
 DB_DATABASE_NAME=
-DATABASE_URL="postgresql://${DB_USER}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_DATABASE_NAME}?schema=public&sslmode=require"
+DATABASE_URL="postgresql://${DB_USER}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_DATABASE_NAME}?schema=public"
 SECRET_KEY=
 
 HOST=::0.0.0.0

.env.local

@@ -6,7 +6,6 @@ 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
 

.eslintrc.js

@@ -21,5 +21,11 @@ module.exports = {
     '@typescript-eslint/explicit-function-return-type': 'off',
     '@typescript-eslint/explicit-module-boundary-types': 'off',
     '@typescript-eslint/no-explicit-any': 'off',
+    "prettier/prettier": [
+      "error",
+      {
+        "endOfLine": "auto"
+      }
+    ]
   },
 };

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 SOS-RS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,111 +1,101 @@
-# README para o Backend do App de Ajuda em Enchentes
+# 🌊 Backend para 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.
+Este repositório contém o backend de um aplicativo projetado para ajudar na organização e distribuição de suprimentos, bem como na coordenação de voluntários durante enchentes no Rio Grande do Sul. Ele fornece APIs essenciais para a autenticação de usuários, gerenciamento de abrigos e suprimentos, e muito mais.
 
-## Tecnologias Utilizadas
+## 🛠 Tecnologias Utilizadas
 
-- **Node.js**: Ambiente de execução para JavaScript.
-- **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.
+- **🟢 Node.js**: Ambiente de execução para JavaScript.
+- **🔗 Prisma**: ORM para Node.js e TypeScript, facilitando o gerenciamento do banco de dados.
+- **🐳 Docker**: Solução para desenvolvimento e execução de aplicativos em contêineres.
+- **🐦 Nest**: Framework de alto desempenho para aplicações web em Node.js.
+- **📦 PostgreSQL**: Banco de dados relacional robusto e eficiente.
 
-## Dump do banco de dados
+## 🗂 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.
+Para iniciar com dados de exemplo, utilize o dump do banco disponível em `prisma/migration/dev_dump.sql`. Este arquivo pode ser executado após as migrations estarem aplicadas.
 
-## Configuração com Docker
+Se estiver usando Docker, os comandos para carregar o dump são:
 
-Caso você esteja desenvolvendo frontend e não precise rodar uma instancia da API e do banco localmente, siga essas
-instruções:
+```bash
+# Copiar o dump para a pasta temporária do Docker
+docker exec -it cp backup.sql POSTGRES_CONTAINER_ID:/tmp/backup.sql
+# Importar o dump para o banco
+docker exec -i POSTGRES_CONTAINER_ID psql -U root -d DATABASE_NAME -f /tmp/backup.sql
+```
+
+## 🐳 Configuração com Docker
 
-1. Clone o .env de exemplo:
+Para desenvolvedores de frontend que não precisam executar localmente a API e o banco, siga estes passos:
+
+1. Clone o arquivo `.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.
-
+2. Use o seguinte comando para criar e iniciar o banco via Docker:
     ```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
+Adicione a porta do serviço de banco no `docker-compose.dev.yml` para acessos externos:
 
 ```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.
-
-## Configuração inicial para rodar localmente
+## 🚀 Configuração Inicial Local
 
 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:
+2. Instale as dependências:
    ```bash
    npm install 
    npx prisma generate 
    npx prisma migrate dev 
    npm run start:dev
    ```
-4. Inicie o servidor:
+3. Inicie o servidor:
    ```bash
    npm start
    ```
-   A API estará acessível via `http://localhost:4000`.
+   A API estará disponível em `http://localhost:4000`.
 
-## API Endpoints
+## 📡 API Endpoints
 
-### Usuários
+### 🧑‍💻 Usuários
 
-- **POST /users** - Cadastrar um novo usuário.
-- **PUT /users** - Atualizar um usuário existente.
+- **📝 POST /users** - Registra um novo usuário.
+- **🔧 PUT /users** - Atualiza um usuário existente.
 
-### Sessões
+### 🚪 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.
+- **📝 POST /sessions** - Inicia uma nova sessão de usuário.
+- **👀 GET /sessions/:sessionId** - Retorna detalhes de uma sessão.
+- **🔧 PUT /sessions/:sessionId** - Atualiza uma sessão.
 
-### Abrigos
+### 🏠 Abrigos
 
-- **POST /shelters** - Cadastrar um novo abrigo.
-- **PUT /shelters/:shelterId** - Atualizar um abrigo existente.
-- **GET /shelters** - Listar abrigos.
+- **📝 POST /shelters** - Registra um novo abrigo.
+- **🔧 PUT /shelters/:shelterId** - Atualiza um abrigo.
+- **👀 GET /shelters** - Lista abrigos.
 
-### Suprimentos
+### 📦 Suprimentos
 
-- **POST /supply** - Cadastrar um novo item de suprimento.
-- **PUT /supplies/:supplyId** - Atualizar um suprimento.
-- **GET /supplies** - Listar suprimentos.
+- **📝 POST /supply** - Registra um novo item de suprimento.
+- **🔧 PUT /supplies/:supplyId** - Atualiza um suprimento.
+- **👀 GET /supplies** - Lista suprimentos.
 
-### Categorias de 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.
+- **📝 POST /supply-categories** - Registra uma nova categoria de suprimentos.
+- **🔧 PUT /supply-categories/:categoryId** - Atualiza uma categoria.
 
-## Contribuição
+## 🤝 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 muito bem-vindas! Se deseja ajudar, faça um fork do repositório, crie uma branch com suas modificações, e envie um pull request.
 
-Sua participação é essencial para ajudarmos a comunidade afetada pelas enchentes no Rio Grande do Sul!
+Sua ajuda é crucial para apoiar a comunidade afetada pelas enchentes no Rio Grande do Sul!