Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 4.01 KB

README.MD

File metadata and controls

65 lines (42 loc) · 4.01 KB
Raw

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

Restaurant App

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

Hack-A-Thing Interlude Update

We decided to jump in and focus on the getting the core frameworks of our application set up for the Hack-A-Thing Interlude.

What we built

We established a git repo and selected our stack. Next, we set up Docker (www.docker.com) in order to easily package our builds for testing and developing on different platforms. We created an initial database schema using Postgres and GORM (a Go ORM library). Finally, we set up a front-end using HTML and CSS with the Bootstrap framework. We created a number of pages on our website to test client-server interaction, Bootstrap features such as navigation bars, and basic Buzzer functionality such as assigning a buzzer to a new party.

What we learned

We learned a lot about the different technologies and languages we played around with - Docker, Gin, Go, HTML, CSS, Bootstrap, and more. We learned about responsive web design and the powerful potential of Go.

What didn't work

We had some difficulty setting up Docker. One of our team members (whose identity will not be revealed) is using a vintage (2010) Apple MacBook Air with a processor that does not support virtualization. Docker requires virtualization, so we had to find a workaround involving boot2docker, which ironically uses a virtual machine to run Docker. We also had trouble with Gin (a tool to automatically compile and reload Go webapps), as it crashed often during our use. We are currently looking into Gin alternatives.

Getting Started

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 3000:3000 -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: gin. This will start the web app on port 3000 (go to localhost:3000 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.

Authors

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