Typescript Project Template

A project template for new mojaloop services and libraries that uses Typescript.

Contributing

Refer to CONTRIBUTING.md for information on how to contribute, committing changes, releases and snapshots.

Template Setup <REMOVE SECTION>

This project provides a decent starting point for a new mojaloop library using typescript.

1. Go to https://github.com/new to create a new repo

2. Select the "mojaloop/template-typescript-public" template

3. Find and replace all instances of <repo-name> globally across the whole project with your new project's name

4. Update the package name and version to match in package.json:

     "name": "@mojaloop/repo-name",
     "version": "0.1.0", 
     ...

5. Copy the necessary circle ci config from the templates.

   cp ./.circleci/config.example.yml ./.circleci/config.yml
   rm -f ./.circleci/config.example.*

   If the project is a Library:

   Make sure to read comments and replace the applicable publish & publish-snapshot jobs with the NPM Publish job variants.

Pre-requisites

Install dependencies

npm install

Build

Command to transpile Typescript into JS:

npm run build

Command to LIVE transpile Typescript into JS live when any changes are made to the code-base:

npm run watch

Run

npm start

Tests

npm test