Skip to content

Latest commit

 

History

History
109 lines (76 loc) · 5.22 KB

README.MD

File metadata and controls

109 lines (76 loc) · 5.22 KB
Raw

Build Status

For embedded code see: https://github.com/jfeiber/buzzer-embedded

To see this live: http://restaur-anteater.herokuapp.com/. Username: anteater, password: password.

Buzzer

We are allowing restaurants to manage their clients better with a web app that displays analytics registered by proprietary restaurant pagers.

Login

Login Page

Waitlist

Login Page

Buzzer Management

Buzzer Management

Analytics

Analytics

Admin Panel

Admin

Architecture

Web App Stack: Golang with Gorilla Mux for routing, GORM for the ORM, Negroni for the HTTP middleware, Gorilla Sessions for session handling, and PostgreSQL for the database. Hosted on Heroku.

Setup and Deployment

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisities

  1. Docker
  2. You can install go locally if you really want but it's pretty annoying to get dependencies working properly.

Installing

  1. Clone this repo
  2. cd into the repo folder and run: docker build -t ra-image .
  3. Start a Postgres container: docker run --name ra-postgres -e POSTGRES_PASSWORD=password -e POSTGRES_USER=ra -d postgres
  4. To start the docker container run: docker run -it --rm --name ra-instance --link ra-postgres:postgres -p 8000:8000 -v $(pwd):/go/src/buzzer -w /go/src/buzzer ra-image
  5. Once the docker container has started, run goose -env dev up to setup the database tables.
  6. Then run: fresh. This will start the web app on port 8000 (go to localhost:8000 to access). Everytime you make changes to server.go it will automatically be recompiled in the docker container and the webapp will be restarted.

Using psql to interact with the DB

Assumes you setup the Postgres container using the above instructions.

  1. Run: docker run -it --rm --link ra-postgres:postgres postgres psql -h postgres -U ra

Using migrations

  1. Start the docker container: docker run -it --rm --name ra-instance --link ra-postgres:postgres -p 3000:3000 -v $(pwd):/go/src/restaur-anteater -w /go/src/restaur-anteater ra-image.
  2. Run goose -env dev up. This will migrate the dev database (the Postgres db running in the Postgres docker container) to the latest migration. Migrations are in db/migrations. To migrate the production database, run goose -env production up.

Adding external go dependencies

  1. Start the docker container: docker run -it --rm --name ra-instance -p 3000:3000 -v $(pwd):/go/src/restaur-anteater -w /go/src/restaur-anteater ra-image.
  2. Run godep restore
  3. Run go get dependency where dependency is something you want to install (like github.com/tools/godep)
  4. Run godep save
  5. Exit the docker container and check (with git diff or something) that the changes to Godeps/Godeps.json didn't do anything crazy.

Deploying to Heroku

Heroku Deployment Instructions. Ask Josh to add you as a contributor to the web app on Heroku if you need to deploy.

General Repo Organization

  • /
    • /assets/: Contains all the frontend assets for the web app.
      • /static/
        • /css/: Contains all the CSS stylesheets used by the web app.
        • /fonts/: Contains fonts/glyphicons used by the web app.
        • /img/: Contains any static images used by the web app. Mostly just pictures of Kevin.
        • /js/: Contains all the Javascript used by the web app.
    • /templates/: Contains all the HTML templates used by the web app.
    • /db/: Used by goose to run manage the databases. dbconf.yml contains the dev and production database info.
      • /migrations/: Contains the actual migration files.
    • /Godeps/: Used by Godep to manage dependencies.
    • /Mockups/: Contains our original frontend mockups.
    • /Screenshots/: Contains current screenshots of the web app.
    • /vendor/: Dependencies.
    • buzzer_name_generator.go: Contains the code that generates a Heroku-style name for the buzzers.
    • Dockerfile: Provisioning info for the Docker container used for local development.
    • ExampleData.sql: Bogus data used for testing.
    • models.go: Our DB models.
    • Procfile: Heroku procfile.
    • README.MD: The READme you are currently reading.
    • server.go: Used to setup and run the actual web app. Creates a session, opens a connection to the database, sets up the router and routes, sets up the middleware, and starts the actual web server.
    • url_handlers.go: Contains all the URL handlers attached to routes created in server.go.

Authors

  • Kevin Neilson
  • Michael Machlin
  • Joon Cho
  • Mickey Alperin
  • Josh Feiber

Acknowledgements

Many thanks to Tim Tregubov for his help and support throughout the project.