Semana OmniStack 11.0 🚀

Projeto    |    Requisitos    |    Tecnologias    |    Clonando    |    Contribuindo    |    Licença

📦 Projeto

O Be The Hero é um projeto que visa auxiliar ONGs a encontrar financiadores para ajudar em problemas específicos.

📝 Requisitos

Para executar esse projeto é necessário ter o Node.js e NPM instalados em seu computador:

• Node.js
• NPM

Após a instalação, verifique se ambos foram instalados corretamente, executando os comandos:

📌 Nota:

• Se os comandos não forem encontrados, reinicie o terminal.

• Se ainda não funcionar, verifique se o caminho onde o Node.js foi instalado, encontra-se nas variáveis de ambiente, se não estiver, insira-o e reinicie o terminal novamente.

• Em último caso, reinstale o Node.js.

⚡ Tecnologias

Esse projeto foi desenvolvido com as seguintes tecnologias:

⚙️ Back-end

• Node.js
• Express
• Knex
• SQLite3

💻 Front-end

• ReactJS
• React Router Dom
• Axios
• React Icons

📱 Mobile

• React Native
• Expo CLI
• React Navigation
• Intl
• Axios
• Expo Mail Composer

📥 Clonando

Para iniciar o projeto em seu computador, primeiramente é necessário clonar esse repositório.
Para isso, abra o seu terminal, navegue até a pasta onde deseja manter o projeto baixado.
Após, digite o seguinte comando:

git clone https://github.com/nicolas-justin/be-the-hero.git

⚙ Iniciando o back-end

Feito o download, iniciaremos o back-end.
Navegue até a pasta be-the-hero/backend:

cd be-the-hero/backend

Agora iremos instalar as dependências do back-end, com o seguinte comando:

npm install

Após baixado as dependências, iremos iniciar o servidor, executando:

npm start

💻 Iniciando o front-end

Agora iremos abrir um novo terminal para o front-end.
Navegue até a pasta be-the-hero/frontend:

cd be-the-hero/frontend

Agora iremos instalar as dependências do front-end, com o seguinte comando:

npm install

Após baixado as dependências, iremos iniciar o servidor, executando:

npm start

📱 Iniciando o mobile

Por último, abriremos mais um terminal para iniciar o mobile. Navegue até a pasta be-the-hero/mobile:

cd be-the-hero/mobile

Agora iremos instalar as dependências do mobile, com o seguinte comando:

npm install

Após baixado as dependências, iremos iniciar o servidor, executando:

npm start

Irá gerar uma URL e um QR Code para conexão.

📌 Nota:

• Para executar a aplicação em seu celular, baixe o aplicativo chamado Expo (Android) ou Expo Client (iOS).

• Feito o download, abra o aplicativo, na aba Tools escolha a opção Scan QR Code.
  Agora é só apontar para o QR Code gerado anteriormente e seu aplicativo irá abrir.

💡 Contribuindo

Siga os passos abaixo para contribuir com a melhoria do projeto:

• Faça um fork desse repositório;
• Crie uma branch com a sua feature: git checkout -b sua-feature;
• Faça commit das suas alterações: git commit -m "Feature: Descrição da sua feature.";
• Faça push para a sua branch: git push origin sua-feature;

📌 Nota:

• Após o merge da sua pull request, não esqueça de deletar a sua branch.

📄 Licença

Esse projeto encontra-se sob a licença MIT.
Para mais detalhes, consulte o arquivo LICENSE.

⬆ Voltar ao topo

---

             

Construído com ❤️ por Nícolas Justin