the official Common beer app
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
client/src
public
server
.babelrc
.env.example
.eslintrc.js
.gitignore
.sequelizerc
CHANGELOG.md
LICENSE
README.md
TODO.md
package-lock.json
package.json
yarn.lock

README.md

On Tap: The CC Beer App.

http://ontap.common.io

Get hacking

  • Check out the MVP Project on Github.
  • Use Github Issues for feature requests, bugs, etc.
  • When developing, use Git Flow and open a PR.
  • There's a #beer channel in Flowdock

The basics

  • Server lives in /server, client lives in /client.
  • The server runs Express and uses Sequelize as an ORM.
    • It serves the client app bundle at /
    • It serves a REST API at /api/v1
  • The client's a basic React app that gets built using Pack

Installation & Development

To fire it up locally:

# requires node 6.5+
# clone the repo
git clone git@github.com:commoncode/ontap
cd ontap
cp .env.example .env
# add any missing vars to .env file (ask dev team)
npm install
npm run build
npm run start

There are a few useful scripts for development, run them all with npm run {script}

  • start: run the Express server
  • dev: run the Express server, restart when /server/* is modified
  • build: build the React app to /client/dist
  • watch: runs a Webpack dev server, hot reloads changes in /client/src
  • test: runs test with Mocha
  • lint: eslint server and client

Deployment

Bit flaky right now. ontap.common.io runs on a Digital Ocean box. Ask Mork for access if you want to deploy yourself.

TODO: get it to deploy on successful merges to master