Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Small productivity app for managing the Friday afternoon employee-funded beer fund balance. Built on Knockout.js+Require.js.
PHP JavaScript CSS
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
dist
src
.gitignore
README.md
grunt.js
package.json

README.md

Threespot Beer Fund

The Threespot Beer Fund app. A small productivity app for managing the Friday afternoon employee-funded beer fund balance. Built on Knockout.js+Require.js.

Versions

  • src/ : All raw source files for development.
  • dist/ : Built application, with require modules concatenated and minified.

All development should be done within src/, then built (see instructions below) and the dist/ files deployed.

Installation

  1. Import src/bf-schema.sql into a new MySQL database. Default app config:
    • DB name: "beerfund"
    • user: "root"
    • pass: "root"
  2. You should be up and running if you used the default app config. Otherwise, adjust the database connection info in src/bf-connection.php.

Build

The application builds using Grunt's Require.js packager. You'll need to install these tools once before making your first build. First, cd into the Beerfund root directory and then run:

npm install -g grunt
npm install

Then to create builds, cd into the Beerfund root directory and run:

grunt

Building the application will assemble Require.js modules into named, minified, and concatenated scripts, and copy all built assets over into the dist/ directory.

Note: the Require.js build process is NOT the same as simply minifying and concatenating scripts the way you would with a service such as Rails' asset pipeline. Require's build process also assigns unique IDs to each module based on the script file it was pulled from. Using other min/concat services will require that you manually assign module IDs based on filename.

Something went wrong with that request. Please try again.