bafana5 / wkrapp

Web front-end for KRApp

wKRApp

wKRApp is the web front-end for the KRApp (Key Responsibility Area Application).

---

About

This web front-end will be the main user interface to the KRApp. The KRApp intends to automate and ease the workflows associated with Key Responsibility Area documents used for performance evaluations in many organisations. This KRApp will be developed in several phases:

• A Minimum Viable Prototype (MVP) will be created with just the front-end and mostly dummy data.
• The KRApp back-end or business logic will be created.
• The front-end will be continually refactored to use the working back-end functionality.

This web front-end is created in Python with the Flask framework.

Contributing Guidelines

Git Workflow

For non core team members please use the following workflow

Fork -> Feature/Issue Branch -> Pull Request -> Comment, Reiterate -> Merge 

Commit Messages

Please follow AngularJS Git Commit Message Conventions.

Python Style

Please ensure the python code adheres to PEP 8

Dependencies

Optional: It is recommended that you use a python virtual environment for development: virtualenvwrapper

You can install the python dependencies with pip:

pip install -r dependencies.txt

Running on local server

Once you have the application and dependencies installed you can serve it locally.

# Previews the app on a local server
python runserver.py

Documentation

No documentation for the MVP phase yet.