Table of Contents

• TaskTracker Server
  • Getting started
  • Usage
  • Models
    • Data item
    • Activity tracker item

TaskTracker Server

A server for interaction with the TaskTracker plugin.

The detail information see in the documentation.

---

Requirements

1. MongoDB
2. Node.js
3. npm

---

Getting started

Do the following steps:

1. Download the repository.
2. Run MongoDB. It has to work on the localhost:27017.
3. Run npm install command from the root folder to install the necessary packages.
4. Run npm start command from the root folder. It will works on the localhost:3000.

If everything is done correctly, you will see the following message:

---

Usage

To generate a database for the TaskTracker plugin send the POST query: <path_to_your_server>/api/database-generator/task-tracker.

Note: the default <path_to_your_server> is localhost:3000.

The data for the database can be found here. You can change data before sending the query.

Note: the query can be sent by using Postman tool. An example with the query is:

---

Models

The section describes the models and routes in the server. The full description for all models see in the documentation.

Data item

The model stores user files from the TaskTracker plugin.

Model

Field	Type	Description
id	ObjectId	internal MongoDB id
externalDiId	Integer	external id
codePath	String	path for the user file in the server
activityTrackerKey	String	external activity-tracker id

Routes

URL	Type	Description
/api/data-item	POST	create a new data-item in the database
/api/data-item/all	GET	get all data-items
/api/data-item/:id	GET	get data-item by external id

Note: you can see more information. See documentation.

Activity tracker item

The model stores activity-tracker files from the codetracker plugin.

Model

Field	Type	Description
id	ObjectId	internal MongoDB id
externalAtiId	Integer	external id
codePath	String	path for the activity tracker file in the server

Routes

URL	Type	Description
/api/activity-tracker-item	POST	create a new activity-tracker-item in the database
/api/activity-tracker-item/all	GET	get all activity-tracker-items
/api/activity-tracker-item/:id	GET	get activity-tracker-item by external id

Note: you can see more information. See documentation.