<div align="center"> <img src="https://res.cloudinary.com/stefanosaffran/image/upload/v1591433716/Omnistack/tkp3avuykaqfpvydmt0i.svg" width="300px"/> </div> <br /> <h2 align="center"> ♻️ NextLevelWeek 1.0 ♻️ </h2> <p align="center"> <img alt="Project programing languages count" src="https://img.shields.io/github/languages/count/StefanoSaffran/ecoleta?color=34cb79"> <img alt="Repository size" src="https://img.shields.io/github/repo-size/StefanoSaffran/ecoleta?color=34cb79"> <img alt="Last commit on GitHub" src="https://img.shields.io/github/last-commit/StefanoSaffran/ecoleta?color=34cb79"> <img alt="Made by Stefano" src="https://img.shields.io/badge/made%20by-StefanoSaffran-%20?color=34cb79"> <img alt="Project top programing language" src="https://img.shields.io/github/languages/top/StefanoSaffran/ecoleta?color=34cb79"> <img alt="GitHub license" src="https://img.shields.io/github/license/StefanoSaffran/ecoleta?color=34cb79"> </p> <p align="center"> <a href="#computer-project">Project</a>   |    <a href="#rocket-built-with">Built with</a>   |    <a href="#information_source-how-to-run">How to run</a>   |    <a href="#memo-license">License</a>   |    <a href="#mailbox_with_mail-get-in-touch">Get in touch</a> </p> <p align="center"> <a href="https://insomnia.rest/run/?label=Run%20in%20Insomnia&uri=https%3A%2F%2Fraw.githubusercontent.com%2FStefanoSaffran%2Fecoleta%2Fmaster%2FInsomnia_2020-06-06.json" target="_blank"><img src="https://insomnia.rest/images/run.svg" alt="Run in Insomnia"> </a> </p>

:computer: Project

Ecoleta is an application that aims to help people find places that collect specific types of waste, encouraging people to recycle more.

:rocket: Built with

This project was developed with the following technologies:

<details> <summary>Backend</summary>

</details> <details> <summary>Frontend</summary>

</details> <details> <summary>Mobile</summary>

</details>

:information_source: How to run

Requirements

To run the application you will need:

I strongly recommend using Docker to run the databases. <br> If you decide to use docker, follow this steps to install and run the docker image.

# install Postgres image (if you don't specify an username it will be postgres by default)
$ docker run --name imagename -e POSTGRES_PASSWORD=yourPassword -p 5432:5432 -d postgres

# start Postgres
$ docker start imageName

Backend

Now clone the repository and install the dependencies.

# to clone the repository
$ git clone https://github.com/StefanoSaffran/ecoleta.git

# go into the backend folder
$ cd ecoleta/backend

#install the backend dependencies
$ yarn

In order to connect to the database, you will need to enter the access informations into a ormconfig.json. You can find more about it here.

# run migrations
$ yarn typeorm migration:run

# run api
$ yarn dev:server

Frontend

# in another tab of the terminal install the frontend dependencies and run it 
$ cd frontend
$ yarn
$ yarn start

Mobile

The Application was developed using Expo. It is a free and open source toolchain built around React Native to facilitate the process of running and testing applications. Click here to get start with Expo.

# install the dependencies
cd mobile
yarn

In order to run the application on your device, you need to change the ip config.

api.ts

  baseURL: 'http://192.168.0.185:3333',

replace 192.168.0.185 with your machine's ip.

Now with everything on place, run the application.


# to run the app
yarn start

Expo will open a page in your browser, scan the QRcode on the page and wait for the app to load.

The Application was developed and tested on Iphone 6s and Android Studio Emulator.

:memo: License

This project is under the MIT license. See the LICENSE for more information

:mailbox_with_mail: Get in touch!

Made with :coffee: and ❤️ by Stefano Saffran.

Ecoleta

Install / Use

README