/Ecoleta

♻️ Software desenvolvido durante Next Level Week #1 by @Rocketseat

Primary LanguageTypeScriptMIT LicenseMIT

Logo

Logo Image

Ecoleta - The easiest way to throw away your trash

GitHub top language Made by Repository size GitHub last commit Repository issues GitHub

📌 Table of Contents

About the project   |    Technologies   |    Getting Started   |    Features   |    License

♻️ About the project

This project was developed on the Next Level Week event by Rocketseat  🚀

This software provide a flow to create recyclable garbage collection points and show in a map around you.

🚀 Technologies

Language:

Backend(Server):

Web:

Mobile:

🔗 Features

  • Register new drop-off location
  • Search for the nearest drop-off location
  • Connect locations to citizens

🏁 Getting Started

Install the requirements

Clone the project and access the folder

$ git clone https://github.com/luishng/Ecoleta.git && cd Ecoleta

Follow the steps below for installation

Server

# Starting from the project root folder, go to server folder
$ cd server

# Install the dependencies
$ yarn

# Use the script to run the migrations
$ yarn knex:migrate

# Use the script to run the seeds
$ yarn knex:seed

# To finish, run the api service
$ yarn dev

# Well done, project is started!

Web

PS: Before to continue, be sure to have the API running (Backend - Server)

# Starting from the project root folder, go to frontend web folder
$ cd web

# Install the dependencies
$ yarn

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

# Start the client
$ yarn start

Mobile

PS: Before to continue, be sure to have the API running (Backend - Server)

# Starting from the project root folder, go to mobile folder
$ cd mobile

# Install the dependencies
$ yarn

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

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

📝 License

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


Made with 💜  by Luis Henrique 👋  See my linkedin 👷