Skip to content

Latest commit

 

History

History
162 lines (111 loc) · 5.3 KB

README.md

File metadata and controls

162 lines (111 loc) · 5.3 KB
Raw

 

 

About | Prototype | Setup | Run | User Tour | Backlogs | Authors |

 

About

The Bottle Genie app is a digital recycling assistant to help the residents of Berlin (especially expats) understand the German bottle and can collection system (Pfandsystem). The app guides its user by helping them identify the type of returnable container (whether it's a single or multiple use one, for instance) and the return location in their area so that they can retrieve the deposit (Pfand) that they paid when buying the product in a returnable container.

 

Prototype

Bottle-Genie-Demo.mp4

 

Setup

Basic requirements:

  • Code editors (VS Code, Atom...)
  • Node.js (v14 and above)
  • MongoDB
  • Nodemon (optional)

 

Client

Use the package manager npm to install the dependencies

  1. From the top-level directory: st22-bottle-genie

  2. Change to folder: $ cd client

  3. Run following commands to install express and dependencies:

npm install

Server

for installation

  1. From the top-level directory: st22-bottle-genie

  2. Change to folder: $ cd server

  3. Run following commands to install express and dependencies:

npm install
  1. Create an .env file.
TOKEN_SECRET=xxxxxx
PORT=xxxx
MONGODB_URI=mongodb://localhost:27017/bottle-genie
MONGODB_URI_LIVE=xxxxxxx

Note: If you find any ImportError messages, continue to install missing dependencies.

 

Running

Run the server:

  1. Go to the directory: st22-bottle-genie/server

  2. Run the following commands:

$ npm start

or

node server.js

Run express run command:

  1. Go to the directory: st22-bottle-genie/client

  2. Run the following commands:

$ npm start

 

User Tour

  • Sign Up
  • Login
  • Homepage with navigation bar.
  • Wiki page with helpful information.
  • Search by brand, volume, material..
  • Result page with map.
  • Scan by camera
  • Log-out

 

Backlogs

  1. Create the features we skipped (e.g., a basket for multiple bottles which shows you the total value of your deposit on all bottles/cans)
  2. Make the app more fun (e.g., with animations), make the gratification aspect a bigger part of it (since it's a mundane topic)
  3. Make the app more responsive so that it's suitable for all devices (we envisioned it as a mobile app only)

 

Authors

This project was created by:

                             Kristina Kulicova