O projeto Net Recipes foi desenvolvido com o objetivo de te ajudar a compartilhar suas melhores receitas e aprender novos pratos.
Instalação e execução | Como contribuir | Licença
ps: Se precisar de ajuda para fazer um clone, esse tutorial aqui vai te ajudar 💖
Primeiramente instale o Node.js e o Yarn, em seguida, clone o projeto rodando este comando:
git clone https://github.com/thgomes/netrecipes-web.git
Instalação das dependências
Rode o seguinte comando no terminal para que as dependências sejam instaladas
yarn install
Variáveis de ambiente
Vá até o arquivo '.env.example' e prencha todos os campos de acordo com as configurações da base de dados e demais tópicos nele especificados. Após preenche-lo, altere o nome do arquivo para '.env'.
Configuração da base de dados
Rode o seguinte comando no terminal para que as tabelas sejam formadas na sua base de dados
yarn sequelize db:migrate
Execução
Rode o seguinte comando para iniciar o servidor em modo de desenvolvimento
yarn dev
Interface
Caso queira ultilizar essa API por meio de uma interface, vá até o repositório Net Recipes WEB e siga as intruções em ordem, para rodar a interface web na sua máquina
Se quiser contribuir para esse repositório aqui, seja corrigindo algum problema, adicionando comentários ou melhorando a documentação, você pode seguir esse tutorial abaixo:
- Faça um fork desse repositório;
- Entre no seu perfil no GitHub e faça um clone do repositório que você fez um fork;
- Crie uma branch com a sua alteração:
git checkout -b minha-alteracao; - Faça as alterações necessárias no código ou na documentação;
- Faça commit das suas alterações:
git commit -m 'feat: Minha nova feature'; - Faça push para a sua branch:
git push origin minha-alteracao; - Agora é só abrir a sua pull request no repositório que você fez o fork;
Depois que o merge da sua pull request for feito, você pode deletar a sua branch.
Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.
Feito com ♥ by Thiago Gomes