Repositório do front-end do Sistema de Gerenciamento de Pedidos (OMS) da empresa Ferreira Costa. Este projeto está sendo desenvolvido durante a residência em software do Porto Digital, utilizando a biblioteca React.
Para rodar o projeto é necessário ter instalado o Node.js e o npm.
- Para instalar o Node.js, acesse o site oficial e faça o download da versão correspondente ao seu sistema operacional.
- O npm já vem instalado com o Node.js.
- Instale o Yarn com o comando
npm install --global yarn.
- Tenha instalado o Node.js em seu computador. 1.1 Caso não possua, realize a instalação por meio deste site Node.js e faça o download da versão correspondente ao seu sistema operacional.
- Abra o seu prompt de comando (CMD) e instale o Yarn com o comando
npm install --global yarn. - Clone o repositório para o seu ambiente local. No seu prompt de comando digite: git clone https://github.com/Rayhene/oms-ferreira-costa.git
- Por meio do prompt de comando (CMD), entre na pasta /front do nosso projeto. Use o comando 'cd front' para acessá-la.
- Dentro da pasta /front execute o comando
yarnno prompt de comando (CMD). - Execute o comando
yarn devpara iniciar o cliente localmente. - Acesse no seu navegador o endereço: http://localhost:5173/.
- Para navegar pelas telas informe as seguintes informações no login: Usuário: teste Senha: teste
Descreveremos abaixo o processo passo a passo para você contribuir com o projeto no GitHub.
1. Clone o Repositório
Para começar, clone o repositório para o seu ambiente local. Execute o seguinte comando no seu terminal: git clone <URL_do_repositório>
2. Crie uma Nova Branch
Antes de fazer alterações no código, crie uma nova branch para trabalhar. Siga o padrão "<seu_nome>-<número_da_tarefa>", por exemplo: "joão-#1", para nomear a branch. Utilize o seguinte comando para criar a branch: git checkout -b nome_da_branch
3. Faça Alterações e Commite
- Após fazer as alterações necessárias, verifique o status do Git para visualizar as modificações:
git status - Adicione os arquivos modificados ao commit usando o seguinte comando:
git add nome_do_arquivo - Se desejar adicionar todos os arquivos modificados, utilize:
git add . - Faça o commit das alterações, seguindo o padrão de commits convencionais (Conventional Commits Pattern) para manter um histórico de alterações consistente e informativo:
git commit -m "feat: mensagem_do_commit_em_inglês"
4. Atualize sua Branch
Antes de enviar o Pull Request, é recomendado obter as últimas atualizações do repositório remoto em sua branch. Execute o seguinte comando para realizar o pull: git pull origin <branch_principal>
5. Publique sua Branch
Publique sua branch no repositório remoto para que outros possam acessá-la e revisar suas alterações. Utilize o comando a seguir para publicar sua branch: git push origin nome_da_branch
6. Envie seu Pull Request
Agora é hora de enviar um Pull Request (PR) para que suas alterações sejam revisadas e incorporadas ao projeto principal. Acesse a página do repositório no GitHub e clique no botão "New Pull Request" ou "Criar novo pull request". Selecione sua branch como "compare" e a branch principal do projeto como "base".
Forneça uma descrição clara e concisa do seu Pull Request, explicando o que foi alterado e por quê. Quando estiver satisfeito com a descrição, clique em "Create Pull Request" ou "Criar Pull Request" para enviá-lo.
7. Revisão e Incorporação
Os colaboradores do projeto revisarão suas alterações, fornecendo comentários e sugestões, se necessário. Esteja preparado para iterar e fazer ajustes com base no feedback recebido. Assim que suas alterações forem aprovadas, um colaborador do projeto irá incorporá-las à branch principal. Agradecemos sua contribuição para o projeto!