Skip to content

Latest commit

 

History

History
122 lines (94 loc) · 6.54 KB

README.md

File metadata and controls

122 lines (94 loc) · 6.54 KB
Raw

Node.js TypeScript Template

Package Version Dependencies Status Build Status Coverage Status Open Issues Commitizen Friendly

A complete Node.js project template using TypeScript and following general best practices. It allows you to skip the tedious details for the following:

  • Adding and configuring TypeScript support.
  • Enabling TypeScript linting.
  • Setting up unit tests and code coverage reports.
  • Creating an NPM package for your project.
  • Managing ignored files for Git and NPM.

Once you've enabled CI, test coverage, and dependency reports for your project, this README.md file shows how to add the badges shown above. This project template even enables automated changelog generation as long as you follow Conventional Commits, which is made simple through the included Commitizen CLI.

Contents

Project Creation

Clone this repo into the directory you want to use for your new project, delete the Git history, and then reinit as a fresh Git repo:

$ git clone https://github.com/chriswells0/node-typescript-template.git <your project directory>
$ cd <your project directory>
$ rm -rf ./.git/
$ git init
$ npm install

Rebranding

It's a common practice to prefix the source code project name with node- to make it clear on GitHub that it's a Node.js project while omitting that prefix in the NPM project since it's understood on npmjs.com. Thus, the order of these replacements matter.

Be sure to check both GitHub and NPMJS to verify that your project name isn't taken before starting!

Use exact searches to perform the following replacements throughout this project for the most efficient rebranding process:

  1. Replace my name with yours: Chris Wells
  2. Replace my website URL with yours: https://chriswells.io
  3. Replace my GitHub username and project name with yours: chriswells0/node-typescript-template
  4. Replace my NPM project name with yours: typescript-template
  5. Update package.json:
    • Change description to suit your project.
    • Update the keywords list.
    • In the author section, add email if you want to include yours.
  6. If you prefer something other than the BSD 3-Clause License, replace the entire contents of LICENSE as appropriate.
  7. Update this README.md file to describe your project.

Managing Your Project

Before committing to a project based on this template, it's recommended that you read about Conventional Commits and install Commitizen CLI globally.

Initial Publish

Some additional steps need to be performed for a new project. Specifically, you'll need to:

  1. Create your project on GitHub (do not add a README, .gitignore, or license).
  2. Add the initial files to the repo:
$ git add .
$ git cz
$ git remote add origin [email protected]:<your GitHub username>/<your project name>
$ git push -u origin master
  1. Create accounts on the following sites and add your new GitHub project to them. The project is preconfigured, so it should "just work" with these tools.
    • GitHub Actions for continuous integration.
    • Coveralls for unit test coverage verification.
  2. Check the "Actions" tab on the GitHub repo and wait for the Node.js CI build to complete.
  3. Publish your package to NPMJS: npm publish

Development Workflow

These steps need to be performed whenever you make changes:

  1. Write awesome code in the src directory.
  2. Build (clean, lint, and transpile): npm run build
  3. Create unit tests in the test directory. If your code is not awesome, you may have to fix some things here.
  4. Verify code coverage: npm run cover:check
  5. Commit your changes using git add and git cz
  6. Push to GitHub using git push and wait for the CI builds to complete. Again, success depends upon the awesomeness of your code.

NPMJS Updates

Follow these steps to update your NPM package:

  1. Perform all development workflow steps including pushing to GitHub in order to verify the CI builds. You don't want to publish a broken package!
  2. Check to see if this qualifies as a major, minor, or patch release: npm run changelog:unreleased
  3. Bump the NPM version following Semantic Versioning by using one of these approaches:
    • Specify major, minor, or patch and let NPM bump it: npm version [major | minor | patch] -m "chore(release): Bump version to %s."
    • Explicitly provide the version number such as 1.0.0: npm version 1.0.0 -m "chore(release): Bump version to %s."
  4. The push to GitHub is automated, so wait for the CI builds to finish.
  5. Publish the new version to NPMJS: npm publish

Contributing

This section is here as a reminder for you to explain to your users how to contribute to the projects you create from this template.