ecoleta: A TypeScript repository from gabrielsanttana

An application that helps people identify recycling collection points ♻️

🛠️ Technologies

⚙️ Requirements

🚀 Installation

$ git clone https://github.com/gabrielsanttana/ecoleta

📦 API

As the web and mobile app consume the same API, it's necessary to have an environment variable with the local IP address inside a .env file in the backend folder root, in order to make React Native able to call the API locally.

Example:

LOCAL_IP_ADDRESS=000.000.00.000

Then:

$ cd ecoleta/backend
$ npm install
$ npm run migrate
$ npm run seed
$ npm start

The API will start serving 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 ecoleta/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 have the local IP address on the baseURL, in the api.ts file.

Example:

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

Then:

$ npm install -g expo-cli
$ cd ecoleta/mobile
$ npm install
$ expo install
$ npm start

A new window with the 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

gabrielsanttana/ecoleta