Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sbstjn/typescript-npm-boilerplate

Publish to NPM with TypeScript, CircleCI and GitHub Releases.
https://github.com/sbstjn/typescript-npm-boilerplate

boilerplate circleci coveralls js kickstart npm ts typescript

Last synced: about 2 months ago
JSON representation

Publish to NPM with TypeScript, CircleCI and GitHub Releases.

Host: GitHub
URL: https://github.com/sbstjn/typescript-npm-boilerplate
Owner: sbstjn
License: mit
Created: 2017-08-03T07:54:29.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2022-08-20T21:10:10.000Z (over 2 years ago)
Last Synced: 2024-10-31T18:06:52.187Z (about 2 months ago)
Topics: boilerplate, circleci, coveralls, js, kickstart, npm, ts, typescript
Language: TypeScript
Homepage: https://sbstjn.com/deploy-typescript-npm-with-circleci-workflows.html
Size: 41 KB
Stars: 14
Watchers: 2
Forks: 8
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # TypeScript NPM Boilerplate

[![npm](https://img.shields.io/npm/v/typescript-npm-boilerplate.svg)](https://www.npmjs.com/package/typescript-npm-boilerplate)

[![CircleCI](https://img.shields.io/circleci/project/github/sbstjn/typescript-npm-boilerplate/master.svg)](https://circleci.com/gh/sbstjn/typescript-npm-boilerplate)

[![license](https://img.shields.io/github/license/sbstjn/typescript-npm-boilerplate.svg)](https://github.com/sbstjn/typescript-npm-boilerplate/blob/master/LICENSE.md)

[![Coveralls](https://img.shields.io/coveralls/sbstjn/typescript-npm-boilerplate.svg)](https://coveralls.io/github/sbstjn/typescript-npm-boilerplate)

A basic boilerplate to write JavaScript NPM modules in TypeScript. The TypeScript code is compiled to JavaScript and published to NPM using CircleCI v2 Workflows and GitHub Releases.

More details at: https://sbstjn.com/deploy-typescript-npm-with-circleci-workflows.html

## Features

- [TypeScript](tsconfig.json) with [linting](tslint.json)

- [Unit testing with Jest](test)

- Coverage reports with [Coveralls](https://coveralls.io)

- Test and PR checks with [CircleCI](circle.yml)

- Publish with [GitHub Releases](https://github.com/sbstjn/typescript-npm-boilerplate/releases)

## Usage

Fork this repository, download it, or clone it and add your custom files and configurations.

### NPM Tasks

- `test` - *Run jest*

- `test:cover` - *Run jest and create coverage report*

- `coveralls` - *Publish coverage report to Coveralls*

- `lint` - *Run tslint*

- `build` - *Build JavaScript files*

## Configuration

### CircleCI

You need to configure two environment variables in CircleCI, one for publishing to NPM and one for Coveralls coverage reports. 

- `NPM_TOKEN`

- `COVERALLS_REPO_TOKEN`

## License

Feel free to use the code, it's released using the [MIT license](LICENSE.md).

## Contribution

You are welcome to contribute to this project! 😘 

To make sure you have a pleasant experience, please read the [code of conduct](CODE_OF_CONDUCT.md). It outlines core values and beliefs and will make working together a happier experience.