Skip to content

Helping people find recycling points in an easy way ♻️!

License

Notifications You must be signed in to change notification settings

yuziem14/ecoleta

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ecoleta

Ecoleta ♻️

🌐 Helping people find recycling points in an easy way.

Author Version License Languages Stars Contributors

Ecoleta - Web App

Ecoleta - Mobile App


Run in Insomnia


This project was build during Next Level Week promoted by Rocketseat

📌 Table of Contents

💡 Features

  • ♻️ Explore recycling points near you.
  • 🌎 Create new recycling points.
  • 🔎 Filter recycling points by: City, UF and Items.
  • 📫 Get in touch with the recycle point by Whatsapp or Email.

🚧 Requirements

  • Git
  • Node.js
  • Expo CLI

✅ Installation

First check if you have all the requirements above, then clone this repository:

  • Using HTTP protocol:

    • git clone https://github.com/Yuziem14/ecoleta.git
  • Using SSH protocol:

Obs: Only clone with SSH if you already have a safe SSH key configured.

🚀 Quick Start

  1. Config the server directory, to run your backend
    Go to the server folder using cd server, then:

    1. In order to install dependencies, run: npm install

    2. In order to config your environment variables, run: cp .env.example .env and setup the HOST and PORT in the .env file

    3. In order to setup the database, run: npm run knex:migrate

    4. In order to seed the database, run: npm run knex:seed

    5. Finally, run your server using: npm run dev

  2. Config the web directory, to run your fronted
    Run the server and go to the web folder using cd web, then:

    1. In order to install dependencies, run: npm install

    2. In order to config your environment variables, run: cp .env.example .env and setup your API URL in the .env file.

    3. Finally, run your app using: npm run start

  3. Config the mobile directory, to run your mobile app
    Run the server and go to the mobile folder using cd mobile, then:

    1. In order to install dependencies, run: npm install

    2. In order to config your environment variables, run: cp src/config/env.example src/config/env.ts and setup your API URL in the env.ts file.

    3. Finally, run your app using: expo start

Obs: If you want, use yarn instead of npm.

🔥 Technologies

This project was build with:

🤖 Contributing

Read the Contribute Guidelines.

📝 License

Read the License for this project.


Made with 💚 by Yuri Ziemba.

About

Helping people find recycling points in an easy way ♻️!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published