Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 1.85 KB

HACKING.md

File metadata and controls

39 lines (30 loc) · 1.85 KB
Raw

GETTING STARTED

  • Get Vagrant

  • Check out the git repository

  • Run vagrant up and follow the instructions. (OK there is one missing thing - it uses compiled JS assets but doesn't actually compile them. You have to install Google Closure Compiler and then do fab compile. Sorry. FIXME)

  • Hack, watching your changes at localhost:8080

  • We follow the Google JS style guide - use gjslint --strict to verify compliance.

  • If you've added a new feature, write unit tests! If you fix a bug, write a unit test! Unit tests are awesome!

  • Make sure you keep the JSDoc tags up to date.

  • Generate documentation by running fabric docs
  • They will appear in ./docs/

OLD INSTRUCTIONS

  • Install the python package virtualenv
  • Set up a virtualenv: virtualenv devenv (or whatever; I use finvisenv)
  • Enter and activate the environment (cd devenv; run whatever activation script suits your shell)
  • Check out the code. It should be a directory called finvis inside devenv. cd there.
  • Install the following required package:
  • MongoDB
  • Inkscape (SVG->PNG converter)
  • fabric: pip install fabric Fabric is like make, but different.
  • fab setup:dev=True This installs a bunch of packages we use: bottle, CherryPy, xlrd, mongoengine, pymongo, pep8, nose, gjslint, etc.
  • jsdoc3: follow the instructions at https://github.com/jsdoc3/jsdoc (either git or node.js) I put the package in devenv/jsdoc, and my fabric file assumes you do too.
  • Optionally install the following useful packages for various projects you might want to take on: