Skip to content

CodeSnooker/ts-library

Repository files navigation

Build Status Coverage Status

ts-library

This is sample typescript library project which can be used base project to build a typescript library.

Creating Library

  1. Clone this repository by running following command. Here we are target folder as lamda. You can change the name if you wish to do so.
git clone https://github.com/CodeSnooker/ts-library.git lamda
  1. We need to change the origin url. We can do so by running following command. Replace the git url with your own repository.
git remote set-url origin https://github.com/USERNAME/REPOSITORY.git
  1. Make sure to update the URL in package.json file also.

  2. Now run npm install

  3. Now you can place your code in lib folder

  4. Write some test and place your test file in _tests_ folder

  5. run npm run test to test your project.

  6. run npm run test:cover to check code coverage

  7. Connect your repositories with Travis-Cli and Coveralls

  8. Commit your code

  9. run npm version patch to push your code along with release tag on the github server.

  10. Don't forget to update README.md for you library.

  11. To publish your library, login to npm.

  12. run npm publish

About

Typescript Library Project for publishing over npm

Resources

License

Stars

Watchers

Forks

Packages

No packages published