Skip to content

A starter kit for developing TypeScript libraries and automating their releases

License

Notifications You must be signed in to change notification settings

llorca/typescript-library-starter

Repository files navigation

TypeScript Library Starter

A starter kit for developing TypeScript libraries and automating their releases.

Installation

Clone this repository and delete the Git history:

git clone https://github.com/llorca/typescript-library-starter && rm -rf typescript-library-starter/.git

Search for the TLS_CONFIG string in the project, then replace each occurrence with your desired configuration.

Initialize as a new repository:

git init

Install the dependencies:

npm install

Usage

Start the webpack development server:

npm run dev

Commit changes with Commitizen:

npm run commit

Automate releases

Sign in to your accounts on NPM and Travis.

Install semantic-release:

npm install -g semantic-release-cli

Set it up. Note that the .travis.yml file already exists so there's no need to create it again via this step.

npx semantic-release-cli setup

Finally, set up the GH_TOKEN and NPM_TOKEN environment variables. More information can be found in the semantic-release documentation.

From now on, a build will run through Travis after every push to the remote GitHub repository. If the build succeeds, a new release will be created on GitHub and published on NPM.

License

MIT

About

A starter kit for developing TypeScript libraries and automating their releases

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published