Skip to content

Latest commit

 

History

History
93 lines (68 loc) · 2.6 KB

README.md

File metadata and controls

93 lines (68 loc) · 2.6 KB

An application where non-governmental organizations can post their incidents so that people can help 🦸‍♂️

🛠️ Technologies

⚙️ Requirements

🚀 Installation

$ git clone https://github.com/gabrielsanttana/be-the-hero

📦 API

$ cd be-the-hero/backend
$ npm install
$ npm run migrate
$ npm start

The API will start running on http://localhost:3333

Note: It's important to have the API running to be able to properly run the web and mobile app

💻 Web

$ cd be-the-hero/frontend
$ npm install
$ npm start 

The application will pop-up in the browser on http://localhost:3000

📱 Mobile

It's also necessary to have a React Native Expo environment setup and the Expo mobile app installed on your smartphone. It's important that both the smartphone and the computer are connected to the same network and to type the local IP address on the baseURL in the api.js file;

Example:

const api = axios.create({
  baseURL: 'http://000.000.00.000:3333',
});

With that:

$ cd be-the-hero/mobile
$ npm install -g expo-cli
$ npm install
$ npm start

A new window with application log will open in the browser

Then, you can simply load the app by scanning the QR code with the Expo mobile app or by using the local URL

⚖️ License

MIT License

Made with ❤️ by Gabriel Santana