/ssv-core

typescript core functions and utils

Primary LanguageTypeScriptMIT LicenseMIT

@ssv/core

CircleCI npm version

Core utilities, components and services for browser and node.

Quick links

Change logs | Project Repository

Installation

Get library via npm

npm install @ssv/core --save

Usage

import { string } from "@ssv/core";

let name = string.interpolate("name=:name", { name: "Chiko" });

Getting Started

Setup Machine for Development

Install/setup the following:

  • NodeJS v10+
  • Visual Studio Code or similar code editor
  • TypeScript 3.1+
  • Git + SourceTree, SmartGit or similar (optional)
  • Ensure to install global NPM modules using the following:
npm install -g git gulp devtool

Project Setup

The following process need to be executed in order to get started.

npm install

Building the code

npm run build

Running the tests

npm test

Watch

Handles compiling of changes.

npm start

Running Continuous Tests

Spawns test runner and keep watching for changes.

npm run tdd

Preparation for Release

  • Update changelogs
  • bump version

Check out the release workflow guide in order to guide you creating a release and publishing it.