🦸‍♀️ Be The Hero's goal is to connect people to NGOs who need help.
Developed at OmniStack#11
Practical project for study

📋 Table of contents

• Status
• Demonstration
• Running Locally


• Running Backend Server
• Running React App
• Running Mobile App


• Technologies
• Author
• License

📌 Status

🦸‍♀️ Be The Hero is complete. 🚀

🖥️ Demonstration

Web Layout

ONG Register

New Case

Mobile

🕹️ Running locally

Prerequisites

1. Installing Git: You need to have Git on your machine to perform a few steps. To download Git, click here.


2. Installing Node: To run the server you will need Node.js, to download it, click here.


3. Installing Expo: To run the mobile, you need to install the Expo, click here.


4. Installing Yarn 1: Yarn is a package manager that you can download directly from the website by clicking here. If you prefer, use the NPM.


5. Code Editor (optional): Make sure you have a code editor of your choice. I recommend using the VS Code. If you need to, download it here.

🎲 Running the backend server

1. In a terminal, clone this repository:

   git clone https://github.com/Silvio-Ronaldo/beTheHero.git

2. Enter the project folder:

   cd beTheHero

3. Enter the server folder:

   cd backend

4. Install all dependencies:

   yarn install or yarn

5. Start the database with Knex migrations:

   yarn knex migrate:latest

6. Start the development server:

   yarn start

7. After these steps, the server should start at the 3333 port.
8. If you want to run the tests, do:

   yarn test

⚛️ Running the React app

1. If you have already cloned the repository, proceed, otherwise, see step 1 in 'Running the backend server'
2. Enter the project folder:

   cd beTheHero

3. Enter the web folder:

   cd frontend

4. Install all dependencies:

   yarn install or yarn

5. Start the web development server:

   yarn start

6. After these steps, the server should start at the 3000 port, open the browser and access http://localhost:3000.

📱 Running the Mobile app

1. With the Expo installed, according to the documentation, follow
2. Enter the project folder:

   cd beTheHero

3. Enter the mobile folder:

   cd mobile

4. Install all dependencies:

   yarn install or yarn

5. Start the mobile development server:

   yarn android or yarn ios according to your emulator / device.

6. After these steps, the mobile application must start on your emulator or on your device, according to your choice.

🛡️ Technologies

The following tools were used in the development of the project:

Backend

• Node
• Knex
• Express
• Celebrate
• SQLite
• Cors

Web

• React
• React Icons
• Axios

Mobile

• React Native
• Expo
• expo-mail-composer
• React Navigation
• React Native Reanimated

👽 Author

Silvio Ronaldo 🍀

Leave your star, fork the project or open a pull request ❤️

Contact me on social networks:

⚖️ License

Be The Hero is MIT licensed, as found in the LICENSE file.