StefanyVasc/Be-the-hero

O Be The Hero é um projeto que visa conectar pessoas interessadas em ajudar ongs com campanhas abertas.

🚀 Semana Omnistack 11.0

Tecnologias   |    Projeto   |    Layout   |    File Insomnia   |    Instalação   |    Como contribuir   |    Licença

🚀 Tecnologias

Esse projeto tem como base as seguintes tecnlogias:

• Node.js
• React
• React Native
• Expo
• SQLite
• Jest

Extras:

• Main Libs
  • Express
  • Axios
  • Nodemon
  • Cors
  • KnexJS
  • Toast Notification
• Estilos
  • EditorConfig
  • ESLint
  • Prettier
• Softwares
  • VSCode
  • Insomnia REST Client

📌 Projeto

O Be The Hero é um projeto que visa conectar pessoas interessadas em ajudar ongs com campanhas abertas.

O projeto conta com um aplicativo onde o usuário pode se tornar o héroi dos casos disponibilizados pelas ONGS. Também conta com site destinado as ongs, onde cada ONG poderá cadastrar casos com as devidas informações, valores necessitados e meios de contato, assim como poderá também excluir o caso se necessário for.

🎨 Layout

Versão mobile --- Hérois (usuários)

Versão web --- Ongs

📁 File Insomnia

O arquivo .json com o arquivo usado no Insomnia está dentro da pasta files. Basta fazer o download e importar no insomnia e usar. Lembre de alterar o que for necessário para que você consiga efetuar as requisições. Ou clique no botão para ser redirecionado

💻 Instalação

O Backend foi construido em NodeJS, certifique-se de ter alguma versão do node instalada em sua máquina. Utilize o Insomnia para realizar os testes na API.
Iniciando o backend:

cd backend
npm install
npm start

Iniciando o Frontend em ReactJS:

cd frontend
npm install
npm start

Assim que o processo terminar, automaticamente será aberta no seu navegador a página localhost:3000 contendo o Projeto.

Iniciando com o Mobile em React Native

1. Coloque o endereço do seu servidor (ou computador) no arquivo src/services/api.js
2. Execute os comandos:

# NÃO é preciso executar a linha de baixo caso ja tenha o Expo (CLI) instalado!
npm install -g expo-cli
cd mobile
npm install
expo start

Será aberta no seu navegador a página localhost:19002. Conecte seu emulador, ou teste o aplicativo por LAN: baixe o aplicativo Expo da Play Store ou App Store e em seguida escaneie o código QR.

🤔 Como contribuir

• 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.

📝 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

---

Feito com ❤️ by Stefany Sá