O projeto foi criado como exemplo para um minicurso de desenvolvimento Web com Node e React. Tal minicurso foi ministrado na VII Semana da Informática da UTFPR - Campus Campo Mourão. A ideia foi desenvolver uma aplicação simples, mas com boas práticas, visando proporcionar uma primeira experiência (com as tecnologias escolhidas, ou até com o próprio desenvolvimento Web) para os participantes. Você pode ver o resultado clicando aqui.
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js. Além disto é bom ter um editor para trabalhar com o código como VSCode. Também é interessante ter um API Client como o Insomnia ou o Postman .
Abra o terminal e siga os seguintes passos:
# Clone este repositório
$ git clone git@github.com:JessePires/back_book_mark.git
# Acesse a pasta do projeto no terminal/cmd
$ cd back_book_mark
# Instale as dependências
# via npm
$ npm install
# via yarn
$ yarnHá também um arquivo um arquivo de exemplo de variáveis de ambiente. Crie uma cópia do mesmo, renomeie-o para apenas `.env` e preencha-o com as informações necessárias.
# Execute a aplicação
$ npm run start:dev
# Execute a aplicação
$ yarn start:dev
# O servidor inciará na porta:3000
As seguintes ferramentas foram usadas na construção do projeto:
Para maiores detalhes de dependências do projeto, veja o arquivo package.json
- Faça um fork do projeto.
- Crie uma nova branch com as suas alterações:
git checkout -b my-feature - Salve as alterações e crie uma mensagem de commit contando o que você fez:
git commit -m "feature: My new feature" - Envie as suas alterações:
git push origin my-feature
Caso tenha alguma dúvida confira este guia de como contribuir no GitHub
Jessé Pires |
Jhonatan Cunha |
Made with ☕ by ©️ Jhonatan Cunha and Jessé Pires.