/EndpointAPI

NestJS REST API for managing users, scheduling waste collections, waste collection orders and much more. Protected with JWT auth.

Primary LanguageTypeScript

ScrapSnap

ScrapSnap Logo

👋 Welcome to ScrapSnap, an innovative Progressive Web Application (PWA) designed to revolutionize waste management and enhance community cleanliness. This README provides an overview of the features, installation instructions, and usage guidelines for ScrapSnap. Plus, with its PWA capabilities, ScrapSnap can seamlessly work offline on both web and mobile platforms, ensuring uninterrupted access to its features regardless of connectivity.

Pitch (Google Slides)

Check out Vue PWA (Typescript, MongoDB, Minio).

Table of Contents

Features

ScrapSnap offers a range of features designed to streamline waste management and encourage community participation:

  • Scheduled Waste Collection: View your area's scheduled waste collection times and dates to ensure timely disposal.
  • Collection Points on Map: Locate nearby waste collection points on an interactive map.
  • Custom Waste Collection Orders: Order custom waste collection services for specific needs or larger quantities of waste.
  • Report Inappropriate Disposal Sites: Take photos of inappropriate or illegal landfill sites and upload them through the app.
  • Earn Points and Discounts: Earn points for reporting issues, which can be redeemed for discounts on various services.

Installation

Usage

Contribution

We welcome contributions from the community! To contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes and commit them (git commit -m 'Add new feature').
  4. Push to the branch (git push origin feature-branch).
  5. Create a pull request detailing your changes.

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov