JaKXz / node-starter

@tufan/node-starter

A simple, full-functionality starter package for node modules, built in TypeScript.

The goal is to be simple, lean and automated.

• minimize dependencies.
• use simpler-to-understand dependencies when necessary.
• enable a move-fast mindset.

Support for the following is baked in:

• tslint
• build automation
• ava test-automation
• test coverage (remapped to TypeScript)
• checks dependencies for known vulnerabilities before commit.
• CI integration
• Code-of-conduct
• Semantic Release

Usage

git clone https://github.com/tufan-io/node-starter my-app
cd my-app
npm install

Since we are using a git repo as a template, a little reconfiguration is required. This has been encapsulated into a simple node pre-install script - .reinit. The script destroys itself after execution, giving your spanking new project a clean start.

node ./.reinit

At this point, explore ./src for the bare bones example. Typically, you'd want to modify ./src/index.ts to get started.

Development Tooling

• Development tooling
• Changelog

License

Apache-2.0

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Support

Bugs, PRs, comments, suggestions welcomed!