https://github.com/antman261/npm-package-template

A template for starting an npm package with testing, linting, styling, types, CI, and documentation.
https://github.com/antman261/npm-package-template

npm npm-package template-repository typescript

Last synced: 4 months ago
JSON representation

A template for starting an npm package with testing, linting, styling, types, CI, and documentation.

• Host: GitHub
• URL: https://github.com/antman261/npm-package-template
• Owner: Antman261
• License: mit
• Created: 2021-05-20T05:35:21.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-05-22T12:37:11.000Z (over 3 years ago)
• Last Synced: 2024-01-17T00:16:06.991Z (about 1 year ago)
• Topics: npm, npm-package, template-repository, typescript
• Language: TypeScript
• Homepage: https://antman261.github.io/npm-package-template/
• Size: 60.5 KB
• Stars: 4
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# NPM Package Template

This is a template NPM package repository. Get started with the following commands:

```shell

git clone https://github.com/Antman261/npm-package-template.git my-package

cd my-package

rm -rf .git

git init

git remote add origin https://github.com//

nvm use

npm i

```

Where `my-package` is the name of your package

Now you can begin developing your package!

## Included package scripts

* `npm run watch` Use this during development to run tests on change

* `npm run build` Build your library

* `npm run build-docs` Builds the documentation using [TypeDoc](http://typedoc.org) and [TypeDoc Markdown](https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-plugin-markdown)

## Setting up GitHub Pages and CircleCI

### GitHub Pages

Hosting your docs on GitHub Pages makes it easier to read the full documentation for your package. TypeDoc will generate markdown for your JSDoc comments. GitHub's Jekyll engine then parses and renders the markdown into HTML on their pages server.

Set up a GitHub Pages site for your package as a *project site* with the following steps:

1. Follow the instructions in the [GitHub Pages Docs](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site) to set up Pages on your GitHub account or organisation if not already configured.

1. Go to your repository for this package on GitHub and click `Settings`

1. Click `Pages`

1. Configure the branch as `main` (or `master`) and the directory to `/docs`

1. Configure the remaining settings as per your own preferences

### CircleCI

A basic [CircleCI](https://circleci.com) config is included in this template. It will install dependencies and run tests. Use this to ensure that pull requests from contributors pass tests.

1. Login to [CircleCI](https://circleci.com) with GitHub

1. Click "Projects"

1. Click "Set up project" for this repository and follow the instructions

Also consider setting up branch protection and requiring passing checks from CircleCI for pull requests.

## Finish setting up your package

You'll need to update the following files and properties to finish setting up your package:

* `package.json` => `"name"`

* `package.json` => `"description"`

* `package.json` => `"repository.url"`

* `package.json` => `"author"`

* `CONTRIBUTING.md` -- Update for your project

* `LICENSE` -- Add your name to the copyright notice or replace with another license.

* `README.md` -- Time to update the file you're reading! Add your own description and usage examples for your package.

After completing the above you can use `npm publish` to publish your package, complete with type definitions and docs.