Para entregar o seu projeto você deverá criar um Pull Request neste repositório.

Lembre-se que você pode consultar nosso conteúdo sobre Git & GitHub e nosso Blog - Git & GitHub sempre que precisar!

Agora que você já aprendeu MongoDB, chegou a hora de praticar todos os conceitos ensinados até aqui por meio do projeto commerce!

Nesse projeto, você vai trabalhar com o banco de dados commerce, que contém dados do cardápio do McDonald's, como ingredientes, valores nutricionais e dados fictícios de vendas. As instruções de como restaurar o banco podem ser lidas a seguir.

• Este projeto é individual;
• Será 1 dia de projeto;
• Data de entrega para avaliação final do projeto: 01/08/2022 14:00.

1. Clone o repositório

• git clone [email protected]:tryber/sd-017-mongodb-commerce.git.

• Entre na pasta do repositório que você acabou de clonar:

  • cd sd-017-mongodb-commerce

2. Crie uma branch a partir da branch master

• Verifique que você está na branch master

  • Exemplo: git branch

• Se não estiver, mude para a branch master

  • Exemplo: git checkout master

• Agora crie uma branch na qual você vai submeter os commits do seu projeto

  • Você deve criar uma branch no seguinte formato: nome-de-usuario-nome-do-projeto
  • Exemplo: git checkout -b seunome-mongodb-commerce

3. Para cada exercício você deve criar um novo arquivo JS dentro de uma pasta na raiz do seu projeto chamada challenges seguindo a seguinte estrutura:

• desafio1.js, desafio2.js, ..., desafioN.js

4. Adicione as mudanças ao stage do Git e faça um commit

• Verifique que as mudanças ainda não estão no stage

  • Exemplo: git status (deve aparecer o arquivo que você alterou como desafio1.js)

• Adicione o novo arquivo ao stage do Git

  • Exemplo:
    • git add . (adicionando arquivo de solução challenges/desafio1.js para desafio 1)
    • git status (deve aparecer listado o arquivo challenges/desafio1.js em verde)

• Faça o commit inicial

  • Exemplo:
    • git commit -m 'iniciando o projeto MongoDB Commerce' (fazendo o primeiro commit)
    • git status (deve aparecer uma mensagem tipo nothing to commit )

5. Adicione a sua branch com o novo commit ao repositório remoto

• Usando o exemplo anterior: git push -u origin joaozinho-sd-017-mongodb-commerce

6. Crie um novo Pull Request (PR)

• Vá até a página de Pull Requests do repositório no GitHub
• Clique no botão verde "New pull request"
• Clique na caixa de seleção "Compare" e escolha a sua branch
• Coloque um título para a sua Pull Request
  • Exemplo: "Cria tela de busca"
• Clique no botão verde "Create pull request"
• Adicione uma descrição para o Pull Request e clique no botão verde "Create pull request"
• Não se preocupe em preencher mais nada por enquanto!
• Volte até a página de Pull Requests do repositório e confira se o seu Pull Request está criado

• Faça commits das alterações que você realizar no código regularmente;

• Lembre-se de sempre após um (ou alguns) commits atualizar o repositório remoto;

• Os comandos que você vai utilizar com mais frequência são:

  1. git status (para verificar o que está em vermelho - fora do stage - e o que está em verde - no stage)
  2. git add (para adicionar arquivos ao stage do Git)
  3. git commit (para criar um commit com os arquivos que estão no stage do Git)
  4. git push -u nome-da-branch (para enviar o commit para o repositório remoto na primeira vez que fizer o push de uma nova branch)
  5. git push (para enviar o commit para o repositório remoto após o passo anterior)

Para sinalizar que o seu projeto está pronto para "Code Review", faça o seguinte:

• Vá até a página DO SEU Pull Request, adicione a label de "code-review" e marque seus colegas:

  • No menu à direita, clique no link "Labels" e escolha a label code-review;

  • No menu à direita, clique no link "Assignees" e escolha o seu usuário;

  • No menu à direita, clique no link "Reviewers" e digite students, selecione o time tryber/students-sd-017.

Caso tenha alguma dúvida, aqui tem um video explicativo.

Use o conteúdo sobre Code Review para te ajudar a revisar os Pull Requests.

Para fazer a análise estática do seu código neste projeto, vamos utilizar o linter ESLint. Assim o código estará alinhado com as boas práticas de desenvolvimento, sendo mais legível e de fácil manutenção!

➡️ Este projeto já vem com as dependências relacionadas ao linter configuradas no arquivo package.json.

➡️ Para poder rodar o ESLint basta:

• Executar o comando npm install dentro do projeto e depois npm run lint.

• Se a análise do ESLint encontrar problemas no seu código, eles serão mostrados no seu terminal.

• Se não houver problema no seu código, nada será impresso no seu terminal.

• Você pode também instalar o plugin do ESLint no VSCode. Para isso, bastar ir em extensions e baixar o plugin ESLint.

⚠️ Importante: Pull Requests com issues de Linter não serão avaliadas. Atente-se para resolvê-las antes de finalizar o desenvolvimento.

• Para executar localmente os testes, é preciso estar na raiz do diretório do projeto e escrever o seguinte no seu terminal,:

./scripts/evaluate.sh

👀 De olho na dica: esse script vai imprimir um relatório indicando se o teste passou ou não para cada desafio. Como a execução do script envolve restauração da base de dados commerce de um teste para outro, recomenda-se esperar pela sua execução completa.

• Para executar somente o teste de um desafio, execute o comando abaixo substituindo N pelo número do desafio

./scripts/evaluate.sh desafioN

⚠️Importante: como o banco de dados commerce é restaurado de um teste para outro durante a avaliação, sempre use o banco restaurado na hora de fazer um desafio. Veja a orientação ➡️ ♻️ Restaurando o banco de dados commerce.

⚠️ Importante: o avaliador automático não necessariamente avalia seu projeto na ordem em que os requisitos aparecem no readme. Isso acontece para deixar o processo de avaliação mais rápido. Então, não se assuste se isso acontecer, ok?

• Para quem não possui o MongoDB instalado e está utilizando o docker, é necessário executar os testes localmente usando os seguintes passos:

1. Acesse o terminal na raiz da pasta do projeto;
2. Crie um container com um volume apontando para a pasta do projeto docker run -d --name=nomeDoContainer -v "$PWD:/app" -p 27017:27017 mongo;
3. Com o container em execução, acesse o terminal do container docker exec -it nomeDoContainer bash;
4. No terminal do container acesse o diretório mapeado no volume (no exemplo acima /app);
5. Por fim, execute o script de testes do projeto: ./scripts/evaluate.sh. Se por algum motivo a execução do container for finalizada, basta iniciá-lo novamente com o comando docker start nomeDoContainer e seguir a partir do passo 3.

1. Abra o terminal e conecte-se à sua instância local do MongoDB. Se você receber uma mensagem de erro como Connection refused, tente reiniciar sua instância seguindo as orientações desse link.

2. Quando sua instância estiver no ar e você estiver conectado a ela, digite exit. Com isso, você voltará ao terminal para iniciar a importação dos dados.

3. Na raiz do diretório do projeto, execute o seguinte comando para restaurar a base de dados commerce: sh DBNAME=commerce ./scripts/resetdb.sh assets/produtos

• A execução desse script criará um banco de dados chamado commerce e importará os dados para a coleção produtos.

⚠️ Importante: tanto o script executado anteriormente quanto o script de execução local dos testes, restauram a base de dados commerce, portanto sempre salve seu progresso nos arquivos de desafio! Veja a orientação ➡️ 🛠 Testes ⚠️

• ⚠ Crie todos os arquivos dentro da pasta challenges ⚠

Esse projeto possui uma série de desafios com diferentes níveis de complexidade. Cada desafio deve ser resolvido em seu arquivo próprio. Para isso:

1. Leia o comando e crie o diretório challenges com um arquivo chamado desafioN.js, em que N é o número do desafio.

2. O arquivo desafioN.js deve conter apenas o código MQL (Mongo Query Language) do desafio resolvido. Lembre-se sempre de incluir o ponto e vírgula (";") no final de suas queries, como no exemplo a seguir:

db.produtos.find();

3. Siga as orientações do passo anterior até finalizar todos os desafios e depois siga as instruções de como entregar o projeto, contidas na Orientação ➡️ 🤝 Depois de terminar o desenvolvimento (OPCIONAL).

4. Para entregar o seu projeto você deve criar um Pull Request neste repositório. Este Pull Request deve conter os arquivos desafio1.js, desafio2.js e assim sucessivamente até o desafio32.js, no diretório challenges, que terá o código MQL de cada desafio, respectivamente.

Caso você opte por não utilizar Docker para realizar os testes na sua máquina local, é necessário que o clone do projeto seja realizado fora do diretório com nome Área de Trabalho. Isso quer dizer que, Área de Trabalho não pode estar no caminho do diretório onde o projeto foi clonado, pois o script que realiza os testes não consegue "encontrar" pastas que contenham espaços em seus nomes. Para checar se seu projeto está seguindo esse passo corretamente, utilize o comando pwd no terminal.

⚠️ Restrições ⚠️:

• Não use aspas simples para especificar campos e/ou valores: quando for necessário usar aspas, use somente aspas duplas;

• Não use o comando use commerce, pois os testes já se conectam automaticamente à base commerce.

• Todos os seus arquivos devem conter os nomes especificados aqui:

./challenges/desafio1.js
./challenges/desafio2.js
./challenges/desafio{...}.js
./challenges/desafio31.js
./challenges/desafio32.js

Ao finalizar e submeter o projeto, não se esqueça de avaliar sua experiência preenchendo o formulário. Leva menos de 3 minutos!

Link: Formulário de avaliação do projeto

Você sabia que o LinkedIn é a principal rede social profissional e compartilhar o seu aprendizado lá é muito importante para quem deseja construir uma carreira de sucesso? Compartilhe esse projeto no seu LinkedIn, marque o perfil da Trybe (@trybe) e mostre para a sua rede toda a sua evolução.