Skip to content

Latest commit

 

History

History
299 lines (206 loc) · 14.4 KB

README-en.md

File metadata and controls

299 lines (206 loc) · 14.4 KB

Ecoleta

♻️ ECOLETA

Your waste collection marketplace. We help the planet to be cleaner!

GitHub language count Repository size Siga no Twitter GitHub last commit License Stargazers made by Rocketseat Stargazers

Status: Finished

AboutFeaturesLayoutHow it worksTech StackContributorsAuthorLicense

About

♻️ Ecoleta - is a way to connect companies and entities that collect organic and inorganic waste to people who need to dispose of their waste in an ecological way. Project developed during ** NLW - Next Level Week ** offered by Rocketseat. NLW is an online experience with lots of practical content, challenges and hacks where the content is available for a week.


Features

  • Companies or entities can register on the web platform by sending:

    • an image of the collection point
    • entity name, email and whatsapp
    • and the address so that it can appear on the map
    • in addition to selecting one or more collection items:
      • lamps
      • Batteries
      • papers and cardboard
      • electronic waste
      • organic waste
      • kitchen oil
  • Users have access to the mobile application, where they can:

    • browse the map to see the registered institutions
    • contact the entity via E-mail or WhatsApp

Layout

The application layout is available on Figma:

Made by tgmarinho

Mobile

Ecoleta Ecoleta

Web

Ecoleta Ecoleta


How it works

This project is divided into three parts:

  1. Backend (server folder)
  2. Frontend (web folder)
  3. Mobile (mobile folder)

Both Frontend and Mobile need the Backend to be running to work.

Pre-requisites

Before you begin, you will need to have the following tools installed on your machine: [Git] (https://git-scm.com), [Node.js] (https://nodejs.org/en/). In addition, it is good to have an editor to work with the code like [VSCode] (https://code.visualstudio.com/)

Rodando o Backend (servidor)

# Clone this repository
$ git clone [email protected]:tgmarinho/README-ecoleta.git

# Access the project folder cmd/terminal
$ cd README-ecoleta

# go to the server folder
$ cd server

# install the dependencies
$ npm install

# Run the application in development mode
$ npm run dev:server

# The server will start at port: 3333 - go to http://localhost:3333

Run in Insomnia

Running the web application (Frontend)

# Clone this repository
$ git clone [email protected]: tgmarinho / README-ecoleta.git

# Access the project folder in your terminal
$ cd README-ecoleta

# Go to the Front End application folder
$ cd web

# Install the dependencies
$ npm install

# Run the application in development mode
$ npm run start

# The application will open on the port: 3000 - go to http://localhost:3000

Tech Stack

The following tools were used in the construction of the project:

Website (React + TypeScript)

See the file package.json

Server (NodeJS + TypeScript)

See the file package.json

See the file package.json

Utilitários


Contributors

A big thanks to this group that made this product leave the field of idea and enter the app stores :)

You are an awesome team! :)


Diego Fernandes


Cleiton Souza


Robson Marques


Claudio Orlandi


Vinícios Fraga


Hugo Duarte

🌐

Joseph Oliveira


Guilherme Rodz


Mayk Brito


João Paulo


Luke Morales


Luiz Batanero

How to contribute

  1. Fork the project.
  2. Create a new branch with your changes: git checkout -b my-feature
  3. Save your changes and create a commit message telling you what you did: git commit -m" feature: My new feature "
  4. Submit your changes: git push origin my-feature

If you have any questions check this guide on how to contribute


Author

Thiago Marinho
Thiago Marinho

Twitter Badge Linkedin Badge Gmail Badge


License

This project is under the license MIT.

Made with love by Thiago Marinho 👋🏽 Get in Touch!


Versions of README

Portuguese | English without emojis | Portugueses without logo