Skip to content

Latest commit

 

History

History

utils

Snipcode Common

This package holds utilities functions that can be used in the Backend or Frontend application

Tech Stack

  • Node.js
  • Typescript

Prerequisites

Make sure you have this tools installed before running the project

  • Node.js 14+
  • NPM or Yarn

Set up the project

Delete the existing folders output from build commands

yarn clean

Install node modules

yarn install

Build the package to generate types declaration required to provide autocompletion while using the functions in the core or web applications

yarn build

A dist folder will be generated.

Running tests

Run the command below to run all the tests

yarn test

To run a specific test file, append the filename after the command

yarn test index.test.ts

Lint the project

ESLint and Prettier are used to normalize the code style across the project. Linting the code make sure there is no error

yarn lint