cristianprochnow / ecoleta

♻ Feel difficulty to find some place to recycle your trash? So this app is perfect for you.

The fastest and practical way to help the natural environment around you.
Explore the docs »

Report Bug · Request Feature

Table of Contents

• About the Project
• Built With
• Features
• Getting Started
  • Prerequisites
  • Installation
    • Server
    • Web
    • Mobile
• Usage
  • Web
  • Mobile
• Contributing
• License
• Contact

About The Project

The fastest way to find the recyclable waste collection point near your home or localization. With a simple click in your smartphone device, you will be able to help the natural environment around you. This simple (and awesome) attitude can transform and change since your self habits, until all the world.

Built With

• Node
• React
• React Native
• Expo

Features

• Sign up a point collector of recyclabe trash.
• Find a point around your home.
• Filter the content of the map by localization or trash type.
• Responsive interface.

And more coming soon...

Getting Started

Prerequisites

• Node
• React Native environment
• Expo

Installation

Server

1. Enter server folder

cd server

2. Install all the packages

# Node
npm install

# Yarn
yarn

3. Start the database

# Node
npm run knex:migrate

# Yarn
yarn knex:migrate

4. Add initial data seed to database

# Node
npm run knex:seed

# Yarn
yarn knex:seed

5. Start the server

# Node
npm run dev

# Yarn
yarn dev

Web

1. Enter web folder

cd web

2. Install all the packages

# Node
npm install

# Yarn
yarn

3. Start the web running

# Node
npm start

# Yarn
yarn start

Mobile

1. Enter mobile folder

cd mobile

2. Install all the packages

# Node
npm install

# Yarn
yarn

3. Start the Expo project

# Expo CLI
expo start

# Node
npm start

# Yarn
yarn start

Usage

Web

Only run the previous command and it's done (you will be redirected to browser page automatically).

If this don't work, go to browser and access http://localhost:3000

Mobile

1. Install the Expo in your IOS or Android device.
2. Enter in your Expo app, and then, select the Scan QR Code functionality.
3. Point the scanner frame to QR code from the browser's page opened (the expo page that you've been redirected when run start command in mobile folder)
4. It's done! After this process the application starts to load and then will be able to work in your smartphone.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. 🍴 Fork the Project
2. 👯 Clone this project (git clone https://github.com/cristianprochnow/Ecoleta.git)
3. 🔀 Create your Feature Branch (git checkout -b my-feature)
4. ✔️ Commit your Changes (git commit -m 'feat: my new feature')
5. 📌 Push to the Branch (git push origin my-feature)
6. 🔁 Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Cristian Prochnow -

Project Link: https://github.com/cristianprochnow/Ecoleta

Made with ♥ in Next Level Week. Enjoy it!