Skip to content

Latest commit

 

History

History
105 lines (76 loc) · 2.89 KB

Development.md

File metadata and controls

105 lines (76 loc) · 2.89 KB
Raw

Development and Testing Guide
Passwords Microservice Client SDK for Node.js

This document provides high-level instructions on how to build and test the client SDK.

Environment Setup

This is a Node.js project and you have to install Node.js tools. You can download them from official Node.js website: https://nodejs.org/en/download/

After node is installed you can check it by running the following command:

node -version

Then you need to configure node tools:

# Install typescript compiler
npm install typescript -g
 
# Install mocha test runner
npm install mocha -g

To work with GitHub code repository you need to install Git from: https://git-scm.com/downloads

Installing

After your environment is ready you can check out microservice source code from the Github repository:

git clone git@github.com:pip-services-users2/client-passwords-node.git

Then go to the project folder and install dependent modules:

# Install dependencies
npm install

If you worked with the client SDK before you can check out latest changes and update the dependencies:

# Update source code updates from github
git pull

# Update dependencies
npm update

Building

This client SDK is written in TypeScript language which is transcompiled into JavaScript. So, if you make changes to the source code you need to compile it before running or committing to github. The process will output compiled javascript files into /bin folder.

tsc

When you do continuous edit-build-test cycle, you can run typescript compiler with --watch option to detect and compile changes you make automatically:

tsc --watch

Testing

Unless you have to do something special, you don't need to worry about configuring and running the microservice. The tests are designed to do that task automatically.

Command to run unit tests:

npm test

You can also execute benchmarks as:

npm run benchmark

Contributing

Developers interested in contributing should read the following instructions:

Please do not ask general questions in an issue. Issues are only to report bugs, request enhancements, or request new features. For general questions and discussions, use the Contributors Forum.

It is important to note that for each release, the ChangeLog is a resource that will itemize all:

  • Bug Fixes
  • New Features
  • Breaking Changes