Skip to content

Commit

Permalink
chore: realizando merge com develop
Browse files Browse the repository at this point in the history
  • Loading branch information
DanielRogs committed Aug 24, 2024
2 parents 6efff72 + 651c40b commit c106bb2
Show file tree
Hide file tree
Showing 37 changed files with 4,762 additions and 1,044 deletions.
2 changes: 1 addition & 1 deletion riso_backend/.env.template
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
MONGODB_URL=
SOFTWARE_URL=
DB_NAME=
DB_NAME=
29 changes: 17 additions & 12 deletions riso_backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Antes de começar, certifique-se de ter os seguintes softwares instalados em sua
- **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

Expand All @@ -21,17 +22,19 @@ git clone https://github.com/usuario/riso-backend.git
cd riso-backend
```

## Instale as dependências
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
## Configuração do Ambiente

## Variáveis de Ambiente
### Variáveis de Ambiente:

Certifique-se de criar um arquivo **.env** na raiz do projeto com as seguintes variáveis de ambiente:

Expand All @@ -41,19 +44,21 @@ 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:

### Local:
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**.

### Atlas (nuvem):
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
## Ambiente de Desenvolvimento:
## Executando o Servidor
1. **Ambiente de Desenvolvimento:**

Para iniciar o servidor em ambiente de desenvolvimento, utilize o comando:

Expand All @@ -63,15 +68,15 @@ npm run dev

Este comando usará o **nodemon** para monitorar as mudanças no código e reiniciar o servidor automaticamente.

## Ambiente de Produção:
2. **Ambiente de Produção:**

Para executar o servidor em ambiente de produção, utilize:

```bash
npm start
```

# Estrutura de Pastas
## Estrutura de Pastas
Abaixo está a estrutura básica das pastas do projeto:

```plaintext
Expand All @@ -94,17 +99,17 @@ riso-backend/
└── README.md # Este manual
```

# Testes
## Testes
Para executar os testes automatizados, utilize o comando:

```bash
npm test
```

# Contribuindo
## Contribuindo
Contribuições são bem-vindas! Siga as diretrizes de contribuição descritas no [CONTRIBUTING.md](../CONTRIBUTING.md)

# Licença
## Licença
Este projeto está sob a licença MIT. Veja o arquivo [LICENSE](../LICENSE) para mais detalhes.


Loading

0 comments on commit c106bb2

Please sign in to comment.