README.md

OmniStack Week 11.0 🚀

Project   |    Technologies   |    Layout   |    How to use   |    License

💻 Project

Be The Hero is a project that aims to connect people who are willing to help ONGs.

🚀 Technologies

This project was developed with the following technologies:

• Node.js
• React
• React Native
• Expo
• Git
• Yarn or NPM

🔖 Layout

To access the layout, use a tool call Figma.

ℹ️ How To Use the Project BeTheHero

To use and run this project, you'll need the technologies of section Technologies installed on your computer.

Now from your terminal, use the commands below:

1: Clone the Repository

# clone this repository
$ git clone https://github.com/rodgeraraujo/BeTheHero

2: Execute API

# go into the repository
$ cd BeTheHero/backend

# install dependencies
$ yarn install #or npm install

# run migrates
$ yarn knex migrate:latest # or npx knex migrate:latest

# run the API
$ yarn run dev #or npm run dev

3: Execute Fron-End

# go into the repository
$ cd BeTheHero/frontend

# install dependencies
$ yarn install #or npm install

# run the frontend
$ yarn start #or npm start

3: Execute Mobile App

# go into the repository
$ cd BeTheHero/mobile

# install dependencies
$ yarn install #or npm install

# run the mobile app (this will open browser page)
$ expo start

# open you expo app and can QR code

📝 License

This project is under the MIT license. See the LICENSE for details.

---

Made with ♥ by Rogério Araújo