README.md

Summary

• 1. Introduction
• 2. Technologies
• 3. Installing and Running
  • 3.1. Introduction
  • 3.2. API (Backend)
  • 3.3. ONGs Admin (Frontend)
  • 3.4. Heroes (Mobile)
• 4. References

1. Introduction

This application lists problems created by a non-governmental organizations and heroes can help them. It was developed at Omni Stack 11, an event promoted by Rockeseat [1].

https://youtu.be/aN1hqTngqWc

Installing and Running video demo.

2. Technologies

• Node.js [2]
• React [3]
• React Native [4]
• Expo [5]

3. Installing and Running

3.1. Introduction

• Clone this repo:

git clone [email protected]:90lucasgabriel/be-the-hero.git

3.2. API (Backend) ☁️

• Access directory:

cd backend

• Install dependencies:

npm install

• Run

npm start

• Access (Postman or Insomnia)

localhost:3333

• Reset database content (optional)

npx knex migrate:rollback
npx knex migrate:latest

3.3. ONGs Admin (Frontend) 💻

• Make sure the API (Backend) is running;
• Access directory:

cd frontend

• Install dependencies:

npm install

• Run

npm start

• Access (Browser)

localhost:3000

3.4. Heroes (Mobile) 📱

• Make sure the API (Backend) is running;
• Access directory:

cd mobile

• Install dependencies:

npm install

• Run

npm start

• Expo server will open in browser

http://localhost:19002

• Scan QR Code to run on device;
• Or select an option to run on emulator;

4. References

[1] Rockeseat - Avaiable on https://rocketseat.com.br/;

[2] Node.js - Avaiable on https://nodejs.org/;

[3] React - Avaiable on https://reactjs.org/;

[4] React Native - Avaiable on https://facebook.github.io/react-native/;

[5] Expo - Avaiable on https://expo.io/;