🦸♀️ Be The Hero's goal is to connect people to NGOs who need help.
Developed at OmniStack#11
Practical project for study
- Installing Git: You need to have Git on your machine to perform a few steps. To download Git, click here.
- Installing Node: To run the server you will need Node.js, to download it, click here.
- Installing Expo: To run the mobile, you need to install the Expo, click here.
- 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.
- 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.
- In a terminal, clone this repository:
git clone https://github.com/Silvio-Ronaldo/beTheHero.git
- Enter the project folder:
cd beTheHero
- Enter the server folder:
cd backend
- Install all dependencies:
yarn install
oryarn
- Start the database with Knex migrations:
yarn knex migrate:latest
- Start the development server:
yarn start
- After these steps, the server should start at the 3333 port.
- If you want to run the tests, do:
yarn test
- If you have already cloned the repository, proceed, otherwise, see step 1 in 'Running the backend server'
- Enter the project folder:
cd beTheHero
- Enter the web folder:
cd frontend
- Install all dependencies:
yarn install
oryarn
- Start the web development server:
yarn start
- After these steps, the server should start at the 3000 port, open the browser and access http://localhost:3000.
- With the Expo installed, according to the documentation, follow
- Enter the project folder:
cd beTheHero
- Enter the mobile folder:
cd mobile
- Install all dependencies:
yarn install
oryarn
- Start the mobile development server:
yarn android
oryarn ios
according to your emulator / device. - After these steps, the mobile application must start on your emulator or on your device, according to your choice.
The following tools were used in the development of the project:
Silvio Ronaldo 🍀 |
Leave your star, fork the project or open a pull request ❤️
Contact me on social networks:
Be The Hero is MIT licensed, as found in the LICENSE file.