Project   |    Technologies   |    Layout   |    How to use   |    How to contribute   |    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

🔖 Layout

Use Figma to access the layout.

ℹ️ How To Use

To clone and run this application, you'll need Git, [Node.js][nodejs] + [Yarn][yarn] installed on your computer.

From your command line:

Install API

# Clone this repository
$ git clone https://github.com/gabriel-brito/semana-omnistack-11

# Go into the repository
$ cd semana-omnistack-11/backend

# Install dependencies
$ yarn install

# Run Migrates
$ yarn knex migrate:latest 

# Run Seeds
$ yarn seed

# Run the API
$ yarn dev

🤔 How to contribute

• Make a fork;
• Create a branck with your feature: git checkout -b my-feature;
• Commit changes: git commit -m 'feat: My new feature';
• Make a push to your branch: git push origin my-feature.

After merging your receipt request to done, you can delete a branch from yours.

📝 License

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

---

Made with <3 - Gabriel Santos - Message me!

*Documentation based on Daniel Obara documentation under the MIT license.