MuriloMarquesSantos / ecoleta

App built to register and find selective waste collection points.

• Summary
• Technologies used
• How-to
• Postman Doc

Summary

For the sake of simplicity, this repository contains:

• Server (Built in node.js with MySQL and Knex.js to connect them)
• WEB (Built in React.js and pure HTML/CSS)
• Mobile (Built with React Native.)

Ecoleta is an application created with the purpose of registering (WEB), searching and locating (APP) recycling points.

Supermarkets, stores and volunteers may register their recycling points and its related information, such as: Location in the map and products that they are willing to receive for recycling.

Technologies used

The project was developed with these technologies:

• TypeScript
• Node.js
• ReactJS
• React Native
• MySQL
• Knex

Result:

• You can check the design layout at: Figma;

How to run

• Firstly, you have to install Node.js. Consider using NVM, for it makes version management easier.
• A dependency manage is also required, here are the two best options: NPM Yarn.
• I used Expo which was installed globally in my machine. Expo was used in the APP part.

1. Clone the repo
2. Execute the app

  Firstly install the dependencies
  $ npm install

  ## Knex creates the database for us. Seed file is meant to contain sample information.
  $ cd server
  $ npm run knex:migrate
  $ npm run knex:seed

  # Start server (For further information about scripts, please check package.json)
  $ npm run dev

  # run web application
  $ cd web
  $ npm start

  # Run app application
  $ cd mobile
  $ npm start

Postman Documentation

I have prepared a postman documentation, in which you will be able to check in details each endpoint and possible Requests and responses.

Please access it by link below:

https://documenter.getpostman.com/view/4694407/SztK35Rf?version=latest

Contributors

• Murilo M. Santos [e-mail]

---

Support

• If you have any query or doubt, please, feel free to contact me by e-mail.