https://github.com/audrow/node-js-template
A starting point for NodeJS Typescript projects.
https://github.com/audrow/node-js-template
Last synced: 11 months ago
JSON representation
A starting point for NodeJS Typescript projects.
- Host: GitHub
- URL: https://github.com/audrow/node-js-template
- Owner: audrow
- License: mit
- Created: 2022-01-29T01:15:16.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-07T04:01:34.000Z (over 3 years ago)
- Last Synced: 2025-03-11T04:38:02.844Z (over 1 year ago)
- Language: TypeScript
- Size: 876 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# README
A template for beginning NodeJS Typescript projects with minimal setup.
This template sets up the following:
- Typescript
- Jest: testing
- Husky: sets up Git hooks to not allow commit unless local checks pass
- ESLint: linting
- Prettier: formats code
- Github Actions CI
- Github Actions for deploying to NPM on a tag
- Dependabot to create PRs when the dependencies run
- Mergify to automatically merge in Dependabot PRs or approved PRs that pass CI
- Convenience commands for performing common operations, such as `npm run validate`
- Build in several different formats so this can be imported as a CommonJS module or ES6 module with types
## Getting started
To get started, clone this repository and run the following:
```bash
npm ci # install dependencies
npm run prepare # setup git hooks
```
From there, you can run the tests to confirm that things are working:
```bash
npm test
```