This project was bootstrapped with Create React App.
Guia:
- Setup - Clonar o repositório pela primeira fez.
- Atualizar o seu fork - Atualizar o seu fork com as mudanças feitas no repositório principal.
- Commit & Pull Request - Contribuir com o repositório.
- Scripts Disponíveis - Comandos disponíveis no projeto.
Bônus:
- Instalar Git - Instalar as ações git.
- Instalar Node + npm - Instalar o NodeJS no seu computador.
- Instalar yarn (opcional) - Instalar o gerenciador de pacotes yarn.
Primeiramente, confira se você já possui Node e os comandos git instalados, caso não, vá até a seção Bônus.
Para instalar e fazer uso deste projeto, siga os seguintes passos:
Clique no canto superior direito do repositório, na opção "fork". Dessa forma, você fará uma cópia do projeto no seu próprio github.
Depois de ter feito o fork, vá na opção "Code", em verde. Ali, faça o clone do seu repositório clicando na opção "Clonar com HTTPS" e copie o link.
Em sua linha de comando (que deve possuir git) digite: git clone [link copiado].
Utilize o comando npm i ou yarn para fazer o download de todas as dependências necessárias.
Com tudo isso realizado, é só rodar o comando npm start ou yarn start.
Caso tenham sido feitas mudanças nesse repositório depois de vc ter feito seu fork, você deve atualizar seu fork para poder fazer seus PRs (Pull Requests).
Se for a primeira fez que está fazendo isso, siga os próximo passos (senão, siga estes):
Na linha de comando, execute git remote add upstream https://github.com/rodcoffani/tcc-vci-front
Na linha de comando, atualize o remote upstream com o comando git fetch upstream
Na linha de comando, entre na sua branch master com git checkout master. Depois disso, git rebase upstream/master.
Para atualizar seu fork depois da primeira vez, sigos os passos:
Atualize o upstream do repositório com o comando git fetch upstream
Para realizar o rebase do repo, entre na sua branch master com git checkout master. Depois disso, git rebase upstream/master.
Quando você realizar as alterações que deseja e quiser enviá-las para o repositório principal e disponibilizar pra todo mundo, você vai precisar fazer Commit com suas mudanças e criar um Pull Request.
O commit faz parte das principais funcionalidades do git, você pode salvar pequenos grupos de mudanças significativas como commits. Ao fazer um commit, você deve incluir uma mensagem que descreva brevemente as alterações.
Para realizar um commit, você deve seguir os seguintes comandos:
git status(sempre usar para conferir quais arquivos foram alterados)git add NOME_ARQUIVO(adicionar o arquivo desejado para ser commitado) ougit add .(adicionar todos os arquivos alterados)git commit -m "MENSAGEM DO COMMIT"(commitar as alterações desejadas)git push(atualizar o seu repositório no github)
O pull request (PR) serve para enviar as alterações do seu repositório para o repositório principal. Depois que um pull request é aberto, você pode discutir e revisar as possíveis alterações com colaboradores e adicionar commits durante o processo de aprovação.
Para criar um PR, é necessário seguir os seguintes passos:
- Entrar no repositório oficial.
- Entrar na aba "Pull requests".
- Clicar no botão "New pull request", em verde.
- Clicar na opção "compare across forks".
- Alterar a origem do PR. (Deve ficar parecido com:
base repository: rodcoffani/tcc-vci-front | base: master <-- head repository: SEU_NOME/tcc-vci-front | compare: master)
Neste projeto, você pode rodar os comandos:
Roda o projeto em modo de desenvolvimento.
Entre em http://localhost:3000 para visualizar em seu navegador.
A página irá atualizar automaticamente ao salvar alterações.
Qualquer erro que ocorra pode ser encontrado no console.
Constrói a aplicação para a forma de produção na pasta build.
Com isso, o projeto é formatado para a produção e otimizado para melhor desempenho
A build é minificada e os nomes dos arquivos incluem hashes.
Agora a aplicação está pronta para ser lançada!
Veja o artigo sobre deploy para mais informações.
Para realizar as ações do git, é necessário que você tenha as linhas de comando instaladas ou que utilize uma interface gráfica.
Caso deseje utilizar uma interface gráfico, uma das melhores opções é o Git Kraken. Para utilizar as linhas de comando do git, é necessário que você faça o download do Git Bash, um terminal específico para isso.
Aqui está um tutorial sobre git, caso queira ;) .
Para rodar o projeto, é necessário ter o Node instalado em seu sistema. O download pode ser feito no site oficial (baixar versão LTS).
Uma vez com o node instalado, teste rodando o comando node -v em seu CMD.
Uma vez instalado o Node, o gerenciador de pacotes npm vem junto, teste roando o comando npm -v.
Outra opção de gerenciador de pacotes é o yarn. Para instalá-lo (após possuir o node), execute o comando npm i -g yarn. Teste a instalação com o comando yarn -v.