📝 Register Employees and Products

Bem-vindo(a). Este é o desafio da 4° sprint!

Opa dev tudo bem?! Este é o grupo03, que através desse repositório vem entregar o 3° desafio do programa de bolsas. O desafio que foi construído com o conteúdo aprendido ao decorrer das Sprints. Colocando dessa vez o trabalho em grupo no desenvolvimento dessa api. Esperamos que goste!!

Vamos ao projeto! #dreamBigger🚀💛

Status code: Finalizada!! ✅

ℹ Indice

• 🧠 Contexto
  • Rotas
• 💻 Baixar e executar o projeto
  • Setup da aplicação
  • Iniciando a aplicação
• 🛠 Tecnologias
• 🌟 Agradecimentos
• ✏ Contribuintes
• 📃 Licença
• 🎁 Bonus

🧠 Contexto

Neste desafio em grupo do programa de bolsas, será a criação de uma api de cadastro de funcionários e produtos. Neste projeto estamos incluído paginação na busca por funcionários e produtos, e fluxos de:

• Interação de métodos http. (criar, buscar, editar e remover);
• Query params nas rotas de buscar;
• validações dos campos;

• Rotas:

- employee

- product

💻 Baixar e executar o projeto

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js, Postman e MongoDB. Além disto é bom ter um editor para trabalhar com o código como VSCode.

O Docker é opicional. Mas caso opte por utilizalo, o Node.js e MongoDB viram opcionais.

🎲 Setup da aplicação

1. Clonando a aplicação localmente

O primeiro passo para começar a configurar o servidor é clonar o repositório na sua máquina.

# Clone este repositório
$ git clone <https://github.com/grupo0003/register-Employees-Products-.git>

# Acesse a pasta do projeto no terminal
$ cd register-Employees-Products-

2. Configurar as variáveis de ambiente

O servidor usa de variáveis de ambiente para transportar dados sensíveis pela aplicação.

Será necessário criar na raiz do projeto um arquivo .env configurar as variáveis:

# Porta que o servidor irá rodar.
PORT=3000

# Driver de conexão com o mongo.
# Caso opte por MongoDB Cluster, DB_DRIVE = mongodb+srv
DB_DRIVE=mongodb

# Endereço do serviço do MongoDB
# No docker, "mongo" é o endereço para fazer a
# comunicação com o container do MongoDB
DB_HOST=mongo

# Este campo é opcional, valor padrão é 27017
DB_PORT=27017

# Usuário para se conectar com o MongoDB
DB_USER=user

# Senha para se conectar com o MongoDB
DB_PASS=pass

# Database que será guardada as Coleções
DB_DATABASE=desafio-03

Utilizando o docker, DB_USER e DB_PASS podem ser qualquer valor.

▶ Iniciando a aplicação

Depois de ter as variáveis de ambiente configuradas, basta iniciar o servidor.

Para subir em modo produção, basta executar:

# Sem docker
$ npm run start

# Com docker
$ npm run docker:up

Para subir em modo desenvolvimento:

# Sem docker
$ npm run dev

# Com docker
$ npm run docker:up:dev

Para iniciar em todo de test (Teste de feature):

# Sem docker
$ npm run test

# Com docker
$ npm docker:up:test

🛠 Tecnologias

As seguintes ferramentas/tecnologias foram usadas na construção e testagem do projeto. Clicando no icone da tecnologia, você será redirecionado para o site oficial para instalação:

logo	Framework	Version
	NodeJs	16.13.1
	MongoDB	5.0.5
	Postman	9.6.2
	VsCode	1.63.2
	Docker	xx.x.x

🌟 Agradecimentos

CompassUol	Felipe	Thais	Diego	Bruna	Gabriel	Giovanni

✏ Contribuintes

Nos do grupo 03 queremos agradecer a toda a equipe da compasso pelo suporte dado a nós ao decorrer desse programa de bolsas e desafios, é muito gratificante termos concluído o projeto dessa sprint, usando o trabalho em grupo e o scrum como metodologia para o desenvolvimento da aplicação.

Obrigado mais uma vez e vamos para o próxima!!#dreamBigger🚀💛

---

📃 LICENÇA

Esse repositório está licenciado pela MIT LICENSE. Para mais informações detalhadas, leia o arquivo LICENSE contido nesse repositório.

🎁 Bonus