/node-typescript-library-starter

A minimalistic node and typescript library compatible for use in Common JS as well as ES modules with test environment setup

Primary LanguageJavaScriptOtherNOASSERTION

Project Name

Short description of the project.

Installation

npm install subashcs-typescript-node-starter

Usage

import { myFunction } from "subashcs-typescript-node-starter";

myFunction();

API

myFunction() Description of the function.

Returns

  • Type: void

Contributing

  1. Fork the repo
  2. Create your feature branch (git checkout -b feature/my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin feature/my-new-feature)
  5. Create a new Pull Request

Project Details

The library folder contains the main source code for our project.

  1. Navigate to library folder
  2. Install dependencies
  3. Add or update new methods inside lib folder , make sure you have export them
  4. Build after changes
  5. Navigate to test folder
  6. To test changes , update index.js file and run test:local script
npm run test:local
  1. Write additional tests
  2. Done

License

MIT License