mikemorcerf/be-the-hero-app

NodeJS, ReactJS and React Native full stack project that lets organizations post incidents they need help with, so users can find them on their mobile app and reach out to the organizations to offer them help.

Be The Hero

Where organizations can find heroes to help them solving incidents 💝

---

📌 Table of Contents

• Technologies
• Features
• Installation and Getting started
• How to Use
• Found a bug? Missing a specific feature?
• Acknowledgment
• License

🔧 Technologies

• Axios
• Celebrate
• Cors
• Dotenv
• Expo
• Express
• Knex
• Node.js
• PostgreSQL
• ReactJS
• React Icons
• React Native
• React Router v4
• Sqlite3

🚀 Features

• Organizations can post incidents they need help with
• Users can find incidents organizations need help with and connect with the organizations to learn how to help them

👷 Installation and Getting Started

# Clone this repository
$ git clone https://github.com/mikemorcerf/be-the-hero-app.git

# Go into the repository
$ cd be-the-hero-app

# Go into backend
$ cd backend

# Install dependencies
$ yarn install

# Start the backend server
$ yarn start

# On another terminal, go to the frontend folder
$ cd ../frontend

# Install dependencies
$ yarn install

# Start the frontend server
$ yarn start

# On another terminal, go to the mobile folder
$ cd ../mobile

# Install dependencies
$ yarn install

# If you want to run the project on a simulador, start the react-native server as it is
$ react-native start

# On another terminal, install the app on your simulator
# Use the command below for iOS devices
$ react-native run-ios --simulator="iPhone XS Max"

# Use the command below for Android devices
$ react-native run-android

# If you want to run the project on your smartphone, change the baseURL on src/services/api.js to your machine's ethernet adapter IP. Use the ethernet adapter IP if you're on a cable connection or the WiFi adapter IP if you're on a wireless conecction.
# After changing the baseURL, start the react-native server
$ react-native start

# On another terminal, install the app on your smartphone
# Use the command below for iOS devices
$ react-native run-ios

# Use the command below for Android devices
$ react-native run-android

🐾 How to Use

Working Online Demo
Organizations must sign up using the web version of Be The Hero application.

After filling up the sign up form and clicking "Register", an unique ID will be generated.
This ID must be stored in secret so just the Organization that created the profile can post incidents.

The Organization must use the ID that was generated to access their Dashboard.

In the Dashboard, Organizations can see all incidents they have posted and can create new incidents.

To create a new incident, the Organization must fill in the incident form and click "Register".

Users can access all of Organizations' incidents and contact information through their mobile application.

🐛 Issues

Feel free to file a new issue with a respective title and description on the Be The Hero repository. If you already found a solution to your problem, I would love to review your pull request!

👏 Acknowledgment

Thanks to Rocketseat for supporting the community and sharing amazing tech content.

📕 License

Released in 2020. This project is under the MIT license.

Made with ♥ by Michael de Morcerf e Moura Say hi!