waiyaki/maintraq

A Maintenance Tracker. Andela Kenya Class V Boot Camp Project. # MainTraq __A Maintenance Tracker. Andela Kenya Class V Boot Camp Project.__ __MainTraq__ (from Maintenance Tracker) is an online maintenance/repairs requests tracker that keeps record of maintenance tasks requested by its users within a particular facility. It provides a platform where a user can file a maintenance request online and obtain feedback about the same from the facility admin. The **facility** can be (but not limited to) an organisation or an organisation's department. __MainTraq__ is written in Python by leveraging the the Flask microframework with its UI primarily being rendered by the `Jinja2` templating engine. ## Main Features * Allow users to request for maintenance * Allow users update descriptions of their requests * Notify users of changes in status of their request * Allow facility admins assign tasks to maintenance crew * Allow maintenance crew update the status of assigned tasks * Provide user authentication and password recovery functions * Provide email notifications to users once their requests are fulfilled ## Getting Started You can view the project's live demo hosted up on Heroku. **NOTE:** Access to the site will require you to sign up. Alternatively, you can easily get a local copy of this application on your workstation. This guide assumes that you have a working installation of `Python 3.4` and `pip` in your workstation 1. Clone this repository `$ git clone github.com` 2. Install project dependencies via `pip`. It's recommended that you do this in a `virtualenv` `$ pip install -r requirements.txt` 3. Initialize your development database. `$ python manage.py db init` 4. Construct the database and migrate the database models. `$ python manage.py db upgrade` 5. Run a development server. `$ python manage.py runserver` ### Configurations If you are developing or deploying __MainTraq__, it will expect the following environment variables: * `MAINTRAQ_ADMIN` - The email address of the system …