Skip to content

A pre-configured Typescript initial framework for creating NPM libraries and modules

License

Notifications You must be signed in to change notification settings

wnqueiroz/typescript-lib-boilerplate

Repository files navigation

typescript-lib-boilerplate

A pre-configured Typescript initial framework for creating NPM libraries and modules

Table of Contents

Getting started

This project is the basis for creating your libraries and APIs!

You just clone the repository:

$ git clone https://github.com/wnqueiroz/typescript-lib-boilerplate.git <MY_PROJECT>

And start working on your codes at: <MY_PROJECT>/src

Key Features

  • TypeScript ✅
  • Prettier + TSLint (soon a version with ESLint) ✅
  • Focus on development experience; 😍

About

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Build

The project build can be done with the following command::

$ npm run build

The project will be compiled in JS in <MY_PROJECT>/dist folder

Author

William Queiroz

License

Copyright © 2020, William Queiroz. Released under the MIT License.

About

A pre-configured Typescript initial framework for creating NPM libraries and modules

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published