Merge pull request #60 from mdsreq-fga-unb/develop

Develop
mdsreq-fga-unb · Sep 10, 2024 · c2bf40c · c2bf40c
2 parents 3f3a8e4 + f3ea0a0
commit c2bf40c
Show file tree

Hide file tree

Showing 92 changed files with 26,789 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,78 @@
+# Guia de Contribuição
+
+Obrigado por considerar contribuir para o projeto RISO! Este documento fornece diretrizes para ajudar você a contribuir de maneira eficaz.
+
+## Como Contribuir
+
+### 1. Reporte um Bug
+
+Se você encontrou um bug, abra uma [issue](https://github.com/mdsreq-fga-unb/2024.1-RISO-/issues) com uma descrição clara do problema. Inclua passos para reproduzir o bug, qual o comportamento esperado e o que realmente aconteceu. Capturas de tela e logs são bem-vindos.
+
+### 2. Solicite um Novo Recurso
+
+Para sugerir novas funcionalidades ou melhorias, abra uma [issue](https://github.com/mdsreq-fga-unb/2024.1-RISO-/issues) e descreva o recurso de maneira detalhada. Explique por que você acha que seria útil e como ele beneficiaria os usuários do projeto.
+
+### 3. Faça um Pull Request
+
+Se você deseja corrigir um bug, implementar um novo recurso ou melhorar o código, siga os passos abaixo:
+
+#### Passo 1: Faça um Fork do Repositório
+
+Crie um fork do repositório clicando no botão “Fork” na página principal do projeto.
+
+#### Passo 2: Clone o Repositório Forked
+
+Clone o repositório forked para sua máquina local:
+
+```bash
+git clone https://github.com/mdsreq-fga-unb/2024.1-RISO-.git
+
+cd 2024.1-RISO-
+```
+
+#### Passo 3: Crie uma Branch
+Crie uma nova branch para suas alterações:
+
+```bash
+git checkout -b feat/minha-feature
+```
+
+Nomeie sua branch de forma descritiva, como correcao-bug-nome ou feature-novo-recurso.
+
+#### Passo 4: Faça suas Alterações
+Implemente suas alterações de forma clara e concisa. Garanta que o código siga as convenções estabelecidas no projeto. Se possível, adicione testes que validem suas mudanças.
+
+#### Passo 5: Execute os Testes
+Antes de enviar o código, certifique-se de que todos os testes estão passando:
+
+```bash
+npm test
+```
+
+#### Passo 6: Commit suas Alterações
+Faça commits das suas alterações com uma mensagem clara e descritiva:
+
+```bash
+git add .
+
+git commit -m "Adiciona funcionalidade X para melhorar Y"
+```
+
+#### Passo 7: Envie as Alterações
+Envie suas alterações para o repositório remoto:
+
+```bash
+git push origin minha-feature
+```
+
+#### Passo 8: Abra um Pull Request
+Vá até o repositório original no GitHub e clique em “Compare & pull request”. Descreva suas mudanças no Pull Request e relacione-o com a issue correspondente, se aplicável.
+
+### Revisão de Pull Requests
+As contribuições serão revisadas pela equipe de mantenedores do projeto. O feedback será dado diretamente no Pull Request. Certifique-se de responder às solicitações de mudança e ajustar o código conforme necessário.
+
+### Políticas de Configuração do Software
+Ao contribuir com este projeto, pedimos que você siga nossa [política de configuração do software](https://mdsreq-fga-unb.github.io/2024.1-RISO-/sections/politicas/GCS/GCS/).
+
+## Agradecimentos
+Agradecemos sua contribuição e empenho em melhorar o projeto RISO!
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 RISO
+
+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.
diff --git a/package-lock.json b/package-lock.json
diff --git a/riso_backend/.env.template b/riso_backend/.env.template
@@ -0,0 +1,4 @@
+MONGODB_URL=
+SOFTWARE_URL=
+DB_NAME=
+SECRET_JWT=
diff --git a/riso_backend/.gitignore b/riso_backend/.gitignore
@@ -0,0 +1,24 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+.env
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/riso_backend/README.md b/riso_backend/README.md
@@ -0,0 +1,115 @@
+# RISO - Backend - Serviço
+
+Este documento serve como um guia para configurar e executar o ambiente de desenvolvimento do serviço backend do projeto RISO.
+
+## Requisitos
+
+Antes de começar, certifique-se de ter os seguintes softwares instalados em sua máquina:
+
+- **Node.js (versão 20.x.x)**
+- **NPM (versão compatível com Node.js 20)**
+- **Git** (para controle de versão)
+- **MongoDB** (caso utilize um banco de dados local)
+- **Nodemon** (Caso rode o banco em modo de desenvolvimento)
+
+## Instalação
+
+1. **Clone o repositório:**
+
+```bash
+git clone https://github.com/usuario/riso-backend.git
+
+cd riso-backend
+```
+
+2. **Instale as dependências**
+
+Utilize o NPM para instalar todas as dependências necessárias do projeto:
+
+```bash
+npm install
+
+npm install nodemon
+```
+
+## Configuração do Ambiente
+
+### Variáveis de Ambiente:
+
+Certifique-se de criar um arquivo **.env** na raiz do projeto com as seguintes variáveis de ambiente:
+
+```env
+MONGODB_URL= (Link do Banco de dados)
+SOFTWARE_HOST= (Link do domínio do site)
+DB_NAME= (Nome do Banco)
+```
+
+(Se você for um dos desenvolvedores do projeto, converse com o gerente do projeto).
+
+## Conexão com o Banco de Dados
+O projeto RISO utiliza o MongoDB como banco de dados. Para configurar a conexão:
+
+1. **Local:**
+
+Se estiver utilizando um banco de dados local, certifique-se de que o MongoDB está rodando na máquina e que as variáveis **MONGODB_URL***, **SOFTWARE_HOST**, **DB_NAME**, estão devidamente configuradas no arquivo **.env**.
+
+2. **Atlas (nuvem):**
+
+Caso utilize o MongoDB Atlas, substitua os valores das variáveis de ambiente com os dados fornecidos pelo Atlas.
+
+## Executando o Servidor
+1. **Ambiente de Desenvolvimento:**
+
+Para iniciar o servidor em ambiente de desenvolvimento, utilize o comando:
+
+```bash
+npm run dev
+```
+
+Este comando usará o **nodemon** para monitorar as mudanças no código e reiniciar o servidor automaticamente.
+
+2. **Ambiente de Produção:**
+
+Para executar o servidor em ambiente de produção, utilize:
+
+```bash
+npm start
+```
+
+## Estrutura de Pastas
+Abaixo está a estrutura básica das pastas do projeto:
+
+```plaintext
+riso-backend/
+│
+├── src/
+│   ├── controllers/    # Lógica de controle das rotas
+│   ├── database/       # Configuração com o banco online MongoDB Atlas
+│   ├── models/         # Definição dos modelos (Schemas do Mongoose)
+│   ├── routes/         # Definição das rotas da API
+│   ├── middlewares/    # Middlewares customizados
+│   ├── services/       # Definição dos serviços de manipulação das rotas
+│   └── index.js        # Ponto de entrada do servidor
+│
+├── .env                # Variáveis de ambiente
+├── .env.template       # Modelo para ser copiado e transformado em .env
+├── .gitignore          # Arquivos ignorados pelo Git
+├── package-lock.json   # Dependências e scripts do projeto
+├── package.json        # Dependências e scripts do projeto
+└── README.md           # Este manual
+```
+
+## Testes
+Para executar os testes automatizados, utilize o comando:
+
+```bash
+npm test
+```
+
+## Contribuindo
+Contribuições são bem-vindas! Siga as diretrizes de contribuição descritas no [CONTRIBUTING.md](../CONTRIBUTING.md)
+
+## Licença
+Este projeto está sob a licença MIT. Veja o arquivo [LICENSE](../LICENSE) para mais detalhes.
+
+