JavaScript CSS HTML
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
controllers
gulp
libs
middlewares
models
public
routes
src/styl
test/requests
utils
views
.editorconfig
.gitignore
CONTRIBUTING.md
LICENSE
Procfile
README.md
app.json
azuredeploy.json
bower.json
config.json
gulpfile.js
package.json
server.js

README.md

The Coffee Club

Motivation

Some time ago in CG Hackspace, we acquired an coffee machine. For some time, control of the capsules consumption was through notes made individually.

Screenshots

Desktop

Mobile

Setup

  1. Clone it:

    git clone git@github.com:brenopolanski/coffee-club.git
    
  2. Install NodeJS, MongoDB and GulpJS, if you don't have it yet.

  3. Install Dependencies:

    cd coffee-club && npm install
    
  4. Adjust config.json:

    {
      "oauth_client_id": "GITHUB_APPLICATION_CLIENT_ID",
      "oauth_client_secret": "GITHUB_APPLICATION_CLIENT_SECRET",
      "oauth_redirect_uri": "GITHUB_APPLICATION_REDIRECT",
      "oauth_scope": "user",
      "oauth_host": "github.com",
      "oauth_port": 443,
      "oauth_path": "/login/oauth/access_token",
      "oauth_method": "POST",
      "port": 3000,
      "members": ["brenopolanski"],
      "secret": "coffeeclub",
      "mongodb": {
        "test": "mongodb://localhost/coffeeclub_test",
        "development": "mongodb://localhost/coffeeclub"
      },
      "cache": {
        "maxAge": 3600000
      }
    }

    Important: Add your GitHub username in members property.

    Also see the documentation on Github OAuth API.

  5. Serve it:

    npm start
    
  6. Execute tests (optional):

    npm test
    

Tasks

  • gulp: Initialize stylus and watch for changes;
  • gulp bower-install: Call for Bower Install;
  • gulp build: Call for PostCSS;
  • gulp stylus: Compile stylus files;
  • gulp watch: Call for watch files.

Deploy on Heroku

Heroku Button

Use the button below to instantly setup your own Coffee Club instance on Heroku.

Deploy

Heroku manually

  1. Create a new Heroku app

    heroku apps:create APP_NAME
    
  2. Add Addons MongoLab

    heroku addons:add mongolab
    
  3. Provide OAUTH_CLIENT_ID and OAUTH_CLIENT_SECRET:

    heroku config:set OAUTH_CLIENT_ID=XXXX OAUTH_CLIENT_SECRET=YYYY
    
  4. Push changes to heroku

    git push heroku master
    

OR

heroku restart

##Deploy on Azure

Azure Button

Use the button below to instantly setup your own Gatekeeper instance on Azure.

Deploy to Azure

Azure manually

  1. Create a new Azure site

    azure site create SITE_NAME --git
    
  2. Provide OAUTH_CLIENT_ID and OAUTH_CLIENT_SECRET:

    azure site appsetting add OAUTH_CLIENT_ID=XXXX 
    azure site appsetting add OAUTH_CLIENT_SECRET=YYYY
    
  3. Push changes to Azure

    git push azure master
    

Support

Browser

Chrome Firefox IE Opera Safari Edge Android iOS Windows Phone
Latest ✔ Latest ✔ 11+ ✔ Latest ✔ 8.0+ ✔ Latest ✔ 4.4+ ✔ 7+ ✔ 8+ ✔

Server

0.10+ ✔

Contributing

If you want to help, please read the Contributing guide.

History

For detailed changelog, see Releases.

License

MIT License © Breno Polanski