@jsallans/node-task-tracking v2.0.1

node-task-tracking-service

Exposes the X by 2 task tracking website as a node service

API

Setup

1) Pull down this repo

2) In node-task-tracking-service project directory run npm link

npm link

3) In the project you are using node-task-tracking run the command

npm link node-task-tracking

Setup (once approved)

1) Install the node module

$ npm install --save @xby2/node-task-tracking

2) Call the API. Example call

const taskTrackingService = require('@xby2/node-task-tracking')

taskTrackingService.getWeeklyTasks('exampleUsername', 'examplePassword')
.then((weeklyTasks) => {
    console.log(`Received ${weeklyTasks.length} tasks`);
})

Contributing

Technology Stack

• Node.js (using ES6)
• TypeScript type file (.d.ts)
• NPM modules
  • Moment
  • Cheerio
  • node-http-ntlm
  • Jest

Local Setup

1) Pull this repository

2) Install all npm modules

$ npm install

3) Run tests

$ npm test

Publishing

1) Run the tests

npm test

2) Check the test coverage. And open ./coverage/lcov-report/index.html

npm run test -- --coverage

3) Run the npm publish task. The documentation updates before publish

npm publish

Contributors

Jeff Sallans