/sd-00-project-movie-cards-library-stg

Primary LanguageJavaScript

Termos de acordo

Ao iniciar este projeto, você concorda com as diretrizes do Código de Ética e Conduta e do Manual da Pessoa Estudante da Trybe.

Boas vindas ao repositório do projeto de Movie Cards Library!

Você já usa o GitHub diariamente para desenvolver os exercícios, certo? Agora, para desenvolver os projetos, você deverá seguir as instruções a seguir. Fique atento a cada passo, e se tiver qualquer dúvida, nos envie por Slack! #vqv 🚀

Aqui você vai encontrar os detalhes de como estruturar o desenvolvimento do seu projeto a partir desse repositório, utilizando uma branch específica e um Pull Request para colocar seus códigos.

Sumário

Habilidades

Nesse projeto, você será capaz de:

  • Saber a melhor forma para instalar um gerenciador de pacotes
  • Inicializar um projeto em React
  • Utilizar JSX no React
  • Utilizar o ReactDOM.render para renderizar elementos numa página web
  • Utilizar o import para usar código externo junto ao seu
  • Criar componentes React corretamente
  • Fazer uso de props corretamente
  • Fazer composição de componentes corretamente
  • Criar múltiplos componentes dinamicamente
  • Utilizar PropTypes para checar o tipo de uma prop no uso de um componente
  • Utilizar PropTypes para garantir a presença de props obrigatórias no uso de um componente
  • Utilizar PropTypes para checar que uma prop é um objeto de formato específico
  • Utilizar PropTypes para garantir que uma prop é um array com elementos de um determinado tipo

Entregáveis

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 sempre que precisar!

O que deverá ser desenvolvido

Você deverá desenvolver uma biblioteca de cartões de filmes utilizando React. A biblioteca deverá possuir um cabeçalho e uma lista de cartões. Cada cartão representa um filme e possui uma imagem, título, subtítulo, sinopse e avaliação. A biblioteca deverá ser algo parecido com a imagem abaixo.

image

Desenvolvimento

Desenvolva uma aplicação React que seja composta por um conjunto de componentes React.

Data de Entrega

  • Serão X dias de projeto.
  • Data de entrega para avaliação final do projeto: DD/MM/YYYY - 14:00h.

Instruções para entregar seu projeto:

Antes de começar a desenvolver:

  1. Clone o repositório
  • git clone git@github.com:tryber/sd-0x-block12-project-movie-cards-library.git.
  • Entre na pasta do repositório que você acabou de clonar:
    • cd sd-0x-block12-project-movie-cards-library
  1. Instale as dependências, inicialize o projeto e rode os testes
  • Instale as dependências:
    • npm install
  • Inicialize o projeto:
    • npm start (uma nova página deve abrir no seu navegador com um texto simples)
  • Verifique que os testes estão executando:
    • npm test (os testes devem rodar e falhar)
  1. 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 onde você vai guardar os commits do seu projeto
    • Você deve criar uma branch no seguinte formato: nome-de-usuario-nome-do-projeto
    • Exemplo: git checkout -b joaozinho-movie-cards-library
  1. Crie a pasta components dentro da pasta src e um arquivo Header.jsx dentro dessa pasta:
  • Verifique que você está na raiz do projeto
    • Exemplo: pwd -> o retorno vai ser algo tipo /Users/joaozinho/code/sd-0x-block12-project-movie-cards-library
  • Crie a pasta components e o arquivo Header.jsx
    • Exemplo:
      • mkdir src/components
      • touch src/components/Header.jsx
      • echo "// Iniciando o projeto 🚀" > src/components/Header.jsx
  1. 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 listada a pasta components em vermelho)
  • Adicione o novo arquivo ao stage do Git
    • Exemplo:
      • git add . (adicionando todas as mudanças - que estavam em vermelho - ao stage do Git)
      • git status (deve aparecer listado o arquivo components/Header.jsx em verde)
  • Faça o commit inicial
    • Exemplo:
      • git commit -m 'iniciando o projeto. VAMOS COM TUDO :rocket:' (fazendo o primeiro commit)
      • git status (deve aparecer uma mensagem tipo nothing to commit )
  1. Adicione a sua branch com o novo commit ao repositório remoto
  • Usando o exemplo anterior: git push -u origin joaozinho-movie-cards-library
  1. 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 com atenção
  • 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 que o seu Pull Request está criado

Durante o desenvolvimento

  • ⚠ PULL REQUESTS COM ISSUES NO CODE CLIMATE NÃO SERÃO AVALIADAS, ATENTE-SE PARA RESOLVÊ-LAS ANTES DE FINALIZAR O DESENVOLVIMENTO! ⚠

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

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

  • Os comandos que você 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)

Depois de terminar o desenvolvimento

Para "entregar" seu projeto, siga os passos a seguir:

  • 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-0x

Se ainda houver alguma dúvida sobre como entregar seu projeto, aqui tem um video explicativo.

⚠ Lembre-se que garantir que todas as issues comentadas pelo Lint estão resolvidas! ⚠

Revisando um pull request

À medida que você e as outras pessoas que estudam na Trybe forem entregando os projetos, vocês receberão um alerta via Slack para também fazer a revisão dos Pull Requests dos seus colegas. Fiquem atentos às mensagens do "Pull Reminders" no Slack!

Use o material que você já viu sobre Code Review para te ajudar a revisar os projetos que chegaram para você.

Como desenvolver

Este repositório já contem um template com um App React criado e configurado. Após clonar o projeto e instalar as dependências (mais sobre isso abaixo), você não precisará realizar nenhuma configuração adicional. Você deverá completar este template implementando os requisitos listados na próxima seção.

Será necessário criar quatro React Components:

  • Header
  • MovieList
  • MovieCard
  • Rating

Cada componente representa uma parte específica do site, conforme ilustrado abaixo:

image

Todos os componentes devem ser criados dentro da pasta src/components. É importante que seus componentes tenham exatamente os nomes listados acima.

Todos os requisitos do projeto serão testados automaticamente. Os testes para cada requisitos estão no arquivo src/App.test.js. Gaste um tempo lendo-o para entender como os testes estão organizados.

Para executar os testes localmente, digite no terminal o comando npm test. Inicialmente, seus testes estarão assim:

image

A primeira parte da saída mostra um sumário de cada teste e seu status. Um ❌ representa um teste falhando, enquanto um ✅ representa um teste correto. Naturalmente, no início todos os testes estarão falhando.

Abaixo do sumário, para cada teste falhando, há uma mensagem explicativa sobre o motivo que causou a falha do teste, assim como a linha em que a falha ocorreu. Na imagem, vemos que o teste falha porque o componente Header, utilizado na linha 38, não está definido.

Se fizermos uma implementação simples do componente Header, que não renderiza nada:

import React from 'react';

class Header extends React.Component {
  render() {
  }
}

export default Header;

E descomentarmos a linha que importa o componente Header em App.test.js:

// import App from './App';
import Header from './components/Header';
// import MovieCard from './components/MovieCard';
// import MovieList from './components/MovieList';
// import Rating from './components/Rating';

Veremos que o primeiro teste agora passa:

image

Quando seu projeto estiver terminado, todos os testes deverão estar passando:

image

Linter

Para garantir a qualidade do código, vamos utilizar neste projeto o linter ESLint e StyleLint. Assim o código estará alinhado com as boas práticas de desenvolvimento, sendo mais legível e de fácil manutenção! Para roda-los localmente no projeto, execute o comando abaixo:

  • npm run lint

⚠️ PULL REQUESTS COM ISSUES DE LINTER NÃO SERÃO AVALIADAS. ATENTE-SE PARA RESOLVÊ-LAS ANTES DE FINALIZAR O DESENVOLVIMENTO! ⚠️

Dica: desativanto testes

Especialmente no início, quando a maioria dos testes está falhando, a saída após executar os testes é bastante poluída. Você pode desabilitar temporariamente um teste utilizando a função skip junto à função it. Como o nome indica, esta função "pula" um teste:

it.skip('it includes the text `Movie Cards Library` inside a h1 tag', () => {
  wrapper = shallow(<Header />);

  expect(wrapper.find('header h1').text()).toBe('Movie Cards Library');
});

Na saída da execução dos testes, você verá um indicando que o teste está sendo pulado:

image

Uma estratégia é pular todos os testes no início e ir implementando um teste de cada vez, removendo dele a função skip.

⚠️ Lembre-se de não entregar o projeto com nenhum teste ignorado. Testes ignoradados serão tratados como testes falhando.

Dica: watch mode

Ao executar os testes localmente, Jest, a ferramenta que executa os testes, entra em watch mode. Nesse modo, a cada vez que um arquivo é salvo, os testes são executados novamente. Isso pode aumentar sua produtividade removendo a necessidade de executar os testes manualmente o tempo todo. Você pode abrir uma aba no seu terminal ou no terminal do VSCode e deixar o Jest rodando nesse modo.

Requisitos do projeto

⚠️ Lembre-se que o seu projeto só será avaliado se estiver passando pelos checks do Lint ⚠️

1 - Crie um componente chamado Header

Esse componente representará o cabeçalho da página.

O que será verificado:

  • O componente Header é renderizado sem quebrar a aplicação.

2 - Renderize o texto "Movie Cards Library" dentro de Header

O texto deverá estar dentro de uma tag h1, que por sua vez deve estar dentro de uma tag header.

O que será verificado:

  • O texto "Movie Cards Library" está dentro de uma tag h1.
  • O h1 deve ser renderizado pelo componente Header.

3 - Crie um componente chamado MovieList

Este componente representará toda a área com os cartões de filmes. MovieList deve receber uma prop movies, que é um array de objetos com informações de um filme.

O que será verificado:

  • O componente MovieList é renderizado sem quebrar a aplicação.

4 - Renderize componentes MovieCard dentro de MovieList

MovieList deve renderizar um componente MovieCard para cada objeto contido no array recebido na prop movies.

O que será verificado:

  • O componente MovieList renderiza a quantidade correta de MovieCard.

5 - Passe uma key para cada MovieCard renderizado

MovieList deve renderizar MovieCards de forma dinâmica. Ou seja, deve utilizar a função map para renderizar uma lista. Cada componente MovieCard deve receber uma prop key com o nome do filme.

O que será verificado:

  • Cada MovieCard renderizado tem como key o título do filme.

6 - Crie um componente chamado MovieCard

Esse componente representa um cartão de filme. MovieCard deve receber uma prop movie. Essa prop será um objeto, contendo as propriedades, title, subtitle, storyline, imagePath e rating.

O que será verificado:

  • O componente MovieCard é renderizado sem quebrar a aplicação.

7 - Renderize a imagem do filme

MovieCard deve renderizar uma tag img, tendo como atributo src o valor da propriedade imagePath do objeto recebido como prop.

O que será verificado:

  • A imagem é renderizada dentro de uma tag img.
  • O atributo src da imagem deve ter o valor de imagePath.

8 - Renderize o título do filme

MovieCard deve renderizar o título do filme dentro de uma tag h4. O título está contido na propriedade title do objeto recebido como prop.

O que será verificado:

  • O título do filme é renderizado dentro de uma tag h4.

9 - Renderize o subtítulo do filme

MovieCard deve renderizar o subtítulo do filme dentro de uma tag h5. O subtítulo está contido na propriedade subtitle do objeto recebido como prop.

O que será verificado:

  • O subtítulo do filme é renderizado dentro de uma tag h5.

10 - Renderize a sinopse do filme

MovieCard deve renderizar a sinopse do filme dentro de uma tag p. A sinopse está contida na propriedade storyline do objeto recebido como prop.

O que será verificado:

  • A sinopse do filme é renderizada dentro de uma tag p.

11 - Renderize um componente Rating dentro de MovieCard

MovieCard deve renderizar um componente Rating.

O que será verificado:

  • O componente Rating é renderizado pelo MovieCard.

12 - Passe como prop para o componente Rating o atributo rating

MovieCard deve passar para o componente Rating uma prop chamada rating. O valor dessa prop é a propriedade rating do objeto recebido na prop movie.

O que será verificado:

  • O componente Rating recebe uma prop chamada rating.
  • O valor da prop rating é a propriedade rating do filme.

13 - Crie um componente chamado Rating

Esse componente representa a avaliação de um filme.

O que será verificado:

  • O componente Rating é renderizado sem quebrar a aplicação.

14 - Renderize a nota de um filme dentro de Rating

Rating deve renderizar a nota do filme recebido na prop rating dentro de um elemento com a classe rating.

O que será verificado:

  • O componente Rating é renderizado dentro de um elemento com a classe rating.

15 - App deve renderizar Header

O componente App deve renderizar um componente Header.

O que será verificado:

  • Apenas um componente Header é renderizado pelo componente App.

16 - App deve renderizar MovieList

O componente App deve renderizar um componente MovieList, passando como prop movies a lista de filmes contida no arquivo data.js. Para isso, você precisará importar data.js dentro de App.js.

O que será verificado:

  • Apenas um componente MovieList é renderizado pelo componente App.
  • MovieList recebe como prop movie a lista do arquivo data.js

17 - Adicione proptypes a todos os componentes

Todos os compontens que recebem props devem ter suas proptypes corretamente declaradas. O eslint checa automaticamente declaração de proptypes, portanto seu Pull Request deverá passar no Code Climate para satisfazer esse requisito.

Avisos Finais

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 DE PROJETO

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?