Skip to content

A web application that helps users find recycling spots, allows authorized leaders to manage waste areas, and streamlines collaboration between citizens and cleanup teams.

License

Notifications You must be signed in to change notification settings

lefcos/TidyTogether

Repository files navigation

logo

TidyTogether

A web application to manage information related to the collection, sorting, and recycling of gargabe

contributors last update forks stars open issues license


📔 Table of Contents

🌟 About the Project

🎯 Features

  • three different perspectives

    • posting procedures for civilians
    • approval of their requests by supervisor (Mayor)
    • the executive forces responses (SalubrIs)
  • map geolocation of waste collecting ares

    • city preference for every user
    • favorite zones and profile management
  • signup protection for unauthorised personnel

  • mime media types storage

  • responsive UI

📷 Screenshots

screenshot screenshot screenshot screenshot screenshot screenshot

👾 Tech Stack

Client:

HTML5 CSS3 JavaScript

Server (Xampp):

PHP Bash PowerShell

Database:

MySQL

🎨 Color Reference

Name Hex Color
Primary Color #017852
Secondary Color #8EBCA6
Accent Color #F8EFE0
Status Color #E62C20
Status Color #FFAC25
Status Color #0C5460
Text Color #000000

🧰 Getting Started

‼️ Prerequisites

Services that bring life to what TidyTogether means:

This project uses Composer as package manager and the following dependencies:

🔑 Environment Variables

To run this project, you will need to add the following variables to your .env file. The "SERVER" variable should be declared only for the remote container (don't declare it locally).

🏃 Run Locally

Windows has our support too: use the .cmd scripts instead of .sh ones.

git clone https://github.com/leftercosmin/TidyTogether.git
cd TidyTogether
# closes the Apache server from Debian in Xampp's favor
./bin/startServer.sh

If "reset" is provided as argument ./bin/startServer.sh reset - the database reached by you local .env is dropped and updated with ./bin/schema.sql

# use this when you want to update the solution with you current directory
./bin/build.sh
# use this to have some default values in your database
./bin/insertSchema.sh

🚩 Deployment

To deploy this project, configure it according to:

Then go to Wasmer and set up the remote .env. The "SERVER" variable is a must have here.

🧪 Running Linter

To run the Css Linter, run the following command

php vendor/bin/php-css-lint app/style/path-to-file.css
php vendor/bin/php-css-lint app/style/civilianHome.css
php vendor/bin/php-css-lint app/style/globals.css

🧭 Roadmap

  • C4 diagrams

  • Checklist

  • System Requirments

  • video

  • favorite zone press

  • load map based on mainCity

  • download pdf

  • paths

👋 Contributing

Contributions are always welcome!

⚠️ License

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

🤝 Contact

💎 Acknowledgements

Useful resources and libraries that you have used in your projects:

About

A web application that helps users find recycling spots, allows authorized leaders to manage waste areas, and streamlines collaboration between citizens and cleanup teams.

Resources

License

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •