Skip to content

Latest commit

 

History

History
73 lines (57 loc) · 2.08 KB

README.md

File metadata and controls

73 lines (57 loc) · 2.08 KB

Beer Game

Implementation of the Beer Game as a webapp.

Technologies

A List of notable technology used.

For a complete list, please look at build.boot under the keyword :dependencies.

Development & Building

Requirements

The Boot Build Tool has to be installed

Development Mode

Run the following command in the project directory:

boot dev

This will start a development server with auto-reloading code, as well as a repl with project-context (which can be connected to using the printed port). The webapp can then be accessed on port 3000 by default.

As this project uses less as a css preprocessor, the boot dev command requires less and less-plugin-clean-css to be installed on the machine, which are best installed using npm.

Generating Documentation

To generate static html pages from the in-code documentation strings, run the following command:

boot doc

The resulting pages will appear in doc/code. They are split into documentation sites for the client- and the server-part of the application, which reside in folders of the same name.

Production Build

Run the following command in the project directory:

boot package

This will create a jar file in the target directory with all dependencies included.

Running

Download or build beer-game.jar and run it using:

java -jar beer-game.jar

Note that there has to be a file called server-config.edn in the directory from which the jar is run from. This file contains some private configuration details, like the password for the game leader. See server-config.edn for an example of the file structure and the included options.