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.
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.
Você precisará implementar um conjunto de componentes em React que irão compor o seu App.
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:
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:
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:
Quando seu projeto estiver terminado, todos os testes deverão estar passando:
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:
Uma estratégia é pular todos os testes no início e ir implementando um teste de cada vez, removendo dele a função skip
.
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.
Esse componente representará o cabeçalho da página.
O texto deverá estar dentro de uma tag h1
, que por sua vez deve estar dentro de uma tag header
.
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.
MovieList
deve renderizar um componente MovieCard
para cada objeto contido no array recebido na prop movies
.
MovieList
deve renderizar MovieCard
s 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.
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
.
MovieCard
deve renderizar uma tag img
, tendo como atributo src
o valor da propriedade imagePath
do objeto recebido como prop.
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.
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.
MovieCard
deve renderizar a sinopse do filme dentro de uma tag p
. A sinopse está contida na propriedade storyline
do objeto recebido como prop.
MovieCard
deve renderizar um componente 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
.
Esse componene representa a avaliação de um filme.
Rating
deve renderizar a nota do filme recebido na prop rating
dentro de um elemento com a classe rating
.
O componente App
deve renderizar um componente Header
.
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
.
- Clone o repositório
git clone [email protected]:tryber/sd-03-block12-project-movie-cards-library.git
.- Entre na pasta do repositório que você acabou de clonar:
cd sd-03-block12-project-movie-cards-library
- 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)
- Crie uma branch a partir da branch
master
- Verifique que você está na branch
master
- Exemplo:
git branch
- Exemplo:
- Se não estiver, mude para a branch
master
- Exemplo:
git checkout master
- Exemplo:
- 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
- Você deve criar uma branch no seguinte formato:
- Crie a pasta
components
dentro da pastasrc
e um arquivoHeader.jsx
dentro dessa pasta:
- Verifique que você está na raiz do projeto
- Exemplo:
pwd
-> o retorno vai ser algo tipo /Users/joaozinho/code/sd-03-block12-project-movie-cards-library
- Exemplo:
- Crie a pasta
components
e o arquivoHeader.jsx
- Exemplo:
mkdir src/components
touch src/components/Header.jsx
echo "// Iniciando o projeto 🚀" > src/components/Header.jsx
- Exemplo:
- 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)
- Exemplo:
- 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)
- Exemplo:
- 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 )
- Exemplo:
- Adicione a sua branch com o novo
commit
ao repositório remoto
- Usando o exemplo anterior:
git push -u origin joaozinho-movie-cards-library
- 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
-
⚠ 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:
git status
(para verificar o que está em vermelho - fora do stage - e o que está em verde - no stage)git add
(para adicionar arquivos ao stage do Git)git commit
(para criar um commit com os arquivos que estão no stage do Git)git push -u nome-da-branch
(para enviar o commit para o repositório remoto na primeira vez que fizer opush
de uma nova branch)git push
(para enviar o commit para o repositório remoto após o passo anterior)
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 timetryber/students-sd-03
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 CodeClimate estão resolvidas! ⚠
⚠⚠⚠
À 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ê.