Visão geral | Tecnologias | Projeto | Instalação | Como contrubuir | Licença
O Be The Hero é um projeto que visa conectar ONG's (Organizações Não Governamentais) com a população. No qual as ONG's podem publicar seus casos de ação, podendo receber quantias financeiras para ajudá-las.
O Be The Hero foi desenvolvido com as seguintes tecnologias:
Para ver conceitos e definição do Backend desse projeto, clique aqui.
- Instalando as depedências:
Primeiramente, para instalar todas as depêndencias do backend, em seu terminal, entre na pasta backend
e rode o comando:
yarn
- Banco de dados:
O banco de dados da aplicação já está configurado, para vê-lo, basta clicar aqui. Nesse projeto, foi utilizado o banco de dados SQLite, que armazena os dados em em arquivo local, que você pode encontrar em backend/src/database/db.sqlite
.
Caso o seu banco de dados dê algum erro, você pode excluir o arquivo e rodar o comando:
yarn knex migrate:latest
- Rotas:
Para testar a API do Be The Hero, baixe e instale o Insomnia e em seguida clique na Workspace → Import/Export
→
Import Data
→ From File
→ e selecione esse arquivo deste repositório.
- Rodando o backend:
Para iniciar o servidor, com seu terminal, entre em
./backend/
e digite o comando:
yarn server
- Faça um fork desse repositório;
- Cria uma branch com a sua feature:
git checkout -b minha-feature
; - 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-feature
.
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 ❤ por João Pedro Araújo. Veja meu Linkedin!