Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.83 KB

README.md

File metadata and controls

46 lines (31 loc) · 1.83 KB

Shttr

Shttr is a webapp that allows users to view and critique nearby restrooms. It is the Yelp equivalent for only bathrooms.

Getting started

Prerequisites

  • Python 3
  • Flask
  • Javascript-enabled browser

Configuration

Run python server.py (contained within the app folder). Next, open index.html in any major browser (primary testing done with Google Chrome).

Usage

The first page loaded will ask for the user's location, required to show services closest to you! From there, bathrooms may be added by navigating andf clicking around the map.

Information about bathrooms can be seen when clicking on the toilet icon. Editing/deleting functions are available toward the buttom of the info drawer.

Help and about features are available in the top navigation bar. Finally, basic user functionality (registering/logging in/logging out) is available in version 0.1a.

Happy shitting!

Primary Components

  • AngularJS - Model View Control system
  • JQuery - Simple animations
  • Flask - Connect the server to the client
  • Python - Back-end development
  • Leaflet - Front-end map data

Contributing

History

  • 2 March 2019: First push.
  • 3 March 2019: Push for project presentation, alpha version 0.1.

Acknowledgements

We would just like to thank the volunteers at RevolutionUC 2019 for providing the rations we needed to develop this web-app. They provided us food, shelter, advice, and a stable wifi connection that allowed us to reach the point we're at.

License

Copyright (c) 2019-2020 Clair Kronk, Braxton Laster, and Jash Gada. All rights reserved.