Giter VIP home page Giter VIP logo

snackru-2016's Introduction

SnackRU

Description

Goals a. to keep track of snack consumption rates for future reference b. to remind volunteers about which things to ration c. delegate tasks like getting water for percolator at predetermined times/making coffee/perform extra cleanup to individual volunteers so Ryan and I don't have to constantly remind them

Inspiration

This app was born out of the desire to use the name "SnackRU"

Installation Guide

Before starting (for the team)

Languages/Frameworks

  • Use Flask to make a python webapp.
  • Use mongoDB to store data about snacks and users (probably using mongoengine python library)
  • Jinja2 templating is used to display the front end (this is standart with Flask apps)

If you haven’t worked with flask before, read up on the basics of Flask http://flask.pocoo.org/docs/1.0/quickstart/

From the docs, you should at least know how to…

  • use app.route( )
  • return redirects to different routes
  • render HTML templates & pass in variables
  • deal with requests

If you plan on dealing with the database, read the mongoengine docs http://docs.mongoengine.org/guide/index.html

Know how to…

  • connect to a database
  • query the db
  • define a “schema” for your db

If you plan on working with the frontend, read about Jinja2 syntax http://jinja.pocoo.org/docs/2.10/templates/

Know how to…

  • use for loops and conditionals to display elements

If you want to deal with login https://flask-login.readthedocs.io/en/latest/

Note that all of these components are sort of connected, so it would benefit everyone to read all of the docs at some point.

Example Uses

  • Volunteers can increment snack counts when hackers take snacks
  • Ryan & Andrea can send notifications to volunteers if they need something done ASAP
  • App will notify users every 30 min to clean table/refill coffee

Style Guide

PEP8 https://www.python.org/dev/peps/pep-0008/

TO-DO List

Necessary Features

  • A login for volunteers
  • A way for volunteers to keep a count of which snacks are taken - I don’t really care how this is implemented, but try to make it as convenient as possible for volunteers
  • A way to remind volunteers what snacks should be placed out at what times - In previous years, we had physical spreadsheets
  • A “alert” box that reminds volunteers to do things at specific time intervals

Links to Further docs

n/a

And whatever you want 🎉

snackru-2016's People

Contributors

andrea-wu avatar toniau avatar

Watchers

James Cloos avatar Qasim Abbas avatar Constantina "Connie" Scoullis avatar Heman Gandhi avatar  avatar  avatar  avatar

Forkers

andrea-wu

snackru-2016's Issues

Update Project Description

In Examples also put use cases of the project here too. Such as how exactly the project is being used at the hackathon (in steps?).

StyleGuide: We want our code to conform to a Code Design Guide of your choice just to make to code we write more uniform as well. Let me know me/Heman know if you have questions about it! An example is using "pylint" that conforms to the style guide PEP8:https://www.python.org/dev/peps/pep-0008/

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.