RichardPinheiro / Ecoleta

🚧 Application In Progress... 🚧

💻 About the project

♻️ 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.

Companies or entities may register on the web platform by sending:

• an image of the collection point
• name of the entity, 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 will 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

Web

Mobile

🛠 Technologies

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

• Expo
• Node.js
• React
• React Native
• TypeScript

🚀 How to execute the project

We can consider this project as being divided into three parts:

1. Backend
2. Frontend Web
3. Frontend Mobile

💡Both Web and Mobile need the Backend to be running to work.

Prerequisites

Before you begin, you will need to have the following tools installed on your machine: Git, Node.js. In addition, it is good to have an editor to work with the code like VSCode

💻 Running the Backend

# Clone this repository
$ git clone https://github.com/RichardPinheiro/Ecoleta.git

# Access the project folder in the / cmd terminal
$ cd ecoleta

# Go to the backend folder
$ cd backend

# Install the dependencies
$ yarn or npm install

# Run the application in development mode
$ yarn dev or npm run dev

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

💻 Running the frontend web

# Clone this repository
$ git clone https://github.com/RichardPinheiro/Ecoleta.git

# Access the project folder in your terminal
$ cd ecoleta

# Go to the Front End application folder
$ cd web

# Install the dependencies
$ yarn or npm install

# Run the application in development mode
$ yarn start or npm run start

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

📱Running the mobile application

🚧 In Progress... 🚧

📢 How to contribute

• Fork this repository
• Create a branch with your feature: git checkout -b my-feature
• Commit your changes: git commit -m 'my new feature'
• Push to your branch: git push origin my-feature
• Open a pull request

After the merge of your pull request is done, you can delete your branch.

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

Authors

• Richard Pinheiro - GitHub