Skip to content

Latest commit

 

History

History
48 lines (26 loc) · 1.11 KB

README.md

File metadata and controls

48 lines (26 loc) · 1.11 KB

![Build Status](http://jenkins.tangentme.com/buildStatus/icon?job=Build UserService) Documentation Status

User Service

User management service authenticates users for all the other micro services projects.

[Documentation] (http://userservice.readthedocs.org/en/latest/)

Setting Up

  1. Start and activate environment

     virtualenv env
     source env/bin/activate
    
  2. Run the requirements

     pip install -r requirements.txt
    
  3. Install the database

     python manage.py syncdb
    
  4. Run the initial data (if required - this is test data only)

     python manage.py loaddata data/initial.json
    
  5. Run the tests to ensure the project is up and running correctly

     python manage.py test
    

Build the Docs

Run the requirements

pip install -r requirements-dev.txt

Manually Build the Docs

cd docs     
make html

Auto Build the Docs as you Edit

cd docs
sphinx-autobuild source build/html -p3000