johnfreitasau/be-the-hero

Be The Hero - Connecting everyone to people in need of change.

About the project   |    Technologies   |    Getting started   |    How to contribute   |    License

🦸‍♀️ About the project

Application developed during the Omnistack week.

Using the web client, the NGOs can create incidents informing about their needs and the amount to solve the incident.

With this informations and using the mobile client, people can help one or more incidents and be the hero for that NGO.

The goal of this project is increase the possibility of to help more cases and faster.

🚀 Technologies

Technologies that I used to develop this api

• Node.js
• ReactJS
• React Native
• Expo
• Express
• Celebrate
• SQLite
• KnexJs
• Nodemon
• React Router DOM
• React Navigation
• React Icons
• Styled Components
• Axios
• EditorConfig

💻 Getting started

Requirements

• Node.js
• Yarn
• Expo

Clone the project and access the folder

$ git clone https://github.com/johnfreitasau/be-the-hero.git && cd be-the-hero

Install dependencies

$ yarn

Follow the steps below

Backend

In the backend folder:

yarn

To start the server:

yarn dev

Migrations

Update the database:

knex migrate:latest

To rollback all the completed migrations:

knex migrate:rollback

To run the next migration that has not yet been run:

knex migrate:up

To undo the last migration that was run:

knex migrate:down

Web

Obs.: Before to continue, be sure to have the API running

In the frontend folder:

yarn

To start the project:

yarn start

Mobile

Obs.: Before to continue, be sure to have the API running

# Be sure the file 'packages/mobile/src/services/api.ts' have the IP to your API

# Start the expo service and scan the QR code with Expo Client
$ yarn mobile expo

🤔 How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork johnfreitasau/be-the-hero

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd be-the-hero

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.