Workhammer 401k: An rpg system for work success </buzzwords>
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
docs
libs
manifests
rpg
static
tests
.gitignore
.travis.yml
LICENSE
Makefile
README.md
Vagrantfile
requirements.dev.txt
requirements.txt

README.md

Workhammer 401k

Webapp backend for an idea on how to reward work. Using an RPG like system of giving experience and leveling up people for their roles (or classes) based on accomplishments during their work. For a better outline of the project, check out the docs.

Technical stuff

The app is written using Python 2.7 with Flask for the web framework and MongoDB as the database backend. It will provide an adaptive RESTful API along with a simple backend generated HTML interface (to start). It is written to use virtualenv. It will be done with good test coverage and against the flake8 (pyflakes + PEP8) linting utility.

Requirements

This project requires a few things to be run on a system. You should have Python installed (the version that it is developed against is 2.7, so no guarantees for anything else for now). Ideally, also at least virtualenv (and possibly virtualenvwrapper) at least on the initial setup. Pip should also be installed. Finally mongo is needed for the Database side of the application.

Setup

To set up, have Vagrant installed. Then just run the command:

vagrant up

from within the project directory, after about 10 minutes, you have a VM running the application. Go to http://127.0.0.1:8080/ and it should be served. You can edit anything in the folder and it will be reflected on the VM. If you want to dig around on the VM, just use vagrant ssh.

Settings

The app settings live in the rpg/settings.py. I have included a template. The file holds various settings for how the application should behave, more settings will be added as functionality and features get added (like when I get around to making the logging at a production level capacity). The current settings are:

  • DEBUG straight forward, boolean that enables debugging settings
  • SECRET_KEY this is a string that is used as part of the salt in password hashes
  • MONGO_HOST dictionary that describes the URI of the mongodb instance to be used, keys are 'host' (the address of the machine) and 'port' (the port the service is listening on)
  • DEFAULT_SESSION dictionary (temporary for now) that defines the defaults for a newly created session, mostly will be things like the default number of items returned for large lists (paginated) and the default datetime format. (nothing for now)
  • STATIC dictionary that describes how the built in debugging server should map the static files, the path is for the URL path (so localhost/s/js/rpg.js by default) and the folder is the relative path to the folder that the static requests looks in.
  • SKILL_DEFAULT a dictionary that describes the default values for a created skill, used for quick skill creation (i.e. just give a name and it will have these values filled in by default)
  • SERVING a dictionary passed into the debug server on how the page is being served including the host and port

License

Licensed under the Apache 2.0 license