Time Tracker

The app tracks the time of stories and tasks. Details of the usage are under Usage. Please refer to Requirements for importing required libraries before looking at how to use it.

Table of contents

• Table of contents
• Requirements
• Usage
• Navigation
• Docker
• Tests
• Public
• Logo
• License

Requirements

Python 3.10.6 is required to properly execute package's modules, imported libraries and defined functions. To install the necessary libraries run requirements.txt file as shown: pip install -r requirements.txt.

For proper usage of the program you might need to run python3 rather than proposed python.¹

¹python or python3 depends on the way how you installed python of version 3.* on your machine.

Usage

After the requirements are met, the app package is set at your directory and terminal is run you have to run the flask app:

>>> conda create --name tracker 
>>> conda activate tracker 
>>> pip install -r requirements.txt
>>> flask db upgrade 
>>> flask run

To look at the functionalities of the app refer to Navigation.

Navigation

When you run flask run you will have a localhost name on terminal like Running on http://127.0.0.1:5000. Navigating to http://localhost:5000/ or http://localhost:5000/story will open the web page that at the top has four names: Stories, Add Story, Add Developer, Developer summary and at the bottom questions of whether you want to add a story (Add Story) or add a developer (Add Developer).

When you add a developer or two of them a dropdown will appear when creating or updating a task (Add task orUpdate task) that will allow to choose developers to be assigned to the task of the story:

• After you press See Story you will be redirected to add tasks for it. If you wish to update a story press Update Story.
• below if a story has been created or delete it by pressing Delete Story at the bottom.
• When you press See Story you will be given an option to Add Task or if one exists already Update Task. Each task also has Delete Task button to delete a task for that story.
• Developer summary gives a summary of all developers assigned to do the tasks of stories. It estimates points for how long it is estimated to complete the tasks of stories while the actual time taken to complete the tasks are calculated for each developer and summarised at Developer summary.

Docker

To build & run docker do these commands: docker build -t tracker . & docker run --name tracker_docker -p 5000:5000 tracker

To run the app then go and follow what is said at Navigation.

Tests

By navigating to the program/app folder where it is extracted - Tracker - one folder before where test folder is held one can run these test commands:

1. To run unit tests in the project folder run:

>>> python -m pytest test/unit/test.py

2. To run functional tests in the project folder run:

>>> python -m pytest test/functional/test.py

3. Or run it with pytest test/functional/test.py or pytest test/unit/test.py

Public

Public folder contains todolist text file and a Logo folder.

Logo

The logo of the Time Tracker can be found here.

License

The MIT LICENSE