/coffee-runner

Decide who wants coffee and who should get it in a fair matter

Primary LanguageJavaScriptMIT LicenseMIT

Build Status

Coffee Runner (WIP)

Decide who wants coffee and who should get it in a fair matter

This application is an Work In Progress and does not work atm.

About

This project uses Feathers. An open source web framework for building modern real-time applications. It also uses Vue. A frontend framework.

Features

These are the futures that the finished application should be able to handle.

  • A user can make and join rooms
  • A user start a coffee run for a given room
  • A user can join a on-going coffee run and enter his choice of beverage
  • A user will be notified when it is his turn for getting coffee

Getting Started

Getting up and running is as easy as 1, 2, 3.

  1. Make sure you have NodeJS and npm installed.

  2. Install your dependencies

    npm install
    
  3. Start your feathers

    npm run feathers_start
    
  4. Serve your Vue application

    npm run vue_serve
    

Testing

Simply run npm test and all your tests in the test/ directory will be run.

Scaffolding

Feathers has a powerful command line interface. Here are a few things it can do:

$ npm install -g @feathersjs/cli          # Install Feathers CLI

$ feathers generate service               # Generate a new Service
$ feathers generate hook                  # Generate a new Hook
$ feathers generate model                 # Generate a new Model
$ feathers help                           # Show all commands

Help

For more information on all the things you can do with Feathers visit docs.feathersjs.com.

Changelog

0.1.0

  • Initial release

License

Copyright (c) 2018

Licensed under the MIT license.