https://github.com/osdevisnot/node-starter
A skeleton for modern nodejs projects.
https://github.com/osdevisnot/node-starter
Last synced: 4 months ago
JSON representation
A skeleton for modern nodejs projects.
- Host: GitHub
- URL: https://github.com/osdevisnot/node-starter
- Owner: osdevisnot
- License: mit
- Created: 2022-05-04T14:38:18.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-05T00:38:59.000Z (almost 3 years ago)
- Last Synced: 2025-01-14T02:47:58.004Z (6 months ago)
- Language: JavaScript
- Size: 147 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node starter
A skeleton for modern nodejs projects.
## Features
- Modern Javascript Syntax transforms
- Best Practices [Multistage Dockerfile](https://docs.docker.com/develop/develop-images/multistage-build/)
- vscode tasks to start server and test using split terminal (try ⌘+⇧+B)
- vscode settings for xo and better DX
## Powered By
- [esbuild](https://esbuild.github.io/) - An extremely fast JavaScript bundler
- [vitest](https://vitest.dev/) - A blazing fast unit-test framework powered by Vite
- [xo](https://github.com/xojs/xo) - JavaScript linter and ESLint wrapper with great defaults
- [prettier](https://prettier.io/) - An opinionated code formatter
## NPM Scripts
| Script | Description |
| -------- | -------------------------------------------- |
| clean | cleans up local workspace |
| start | runs http server based on native `node:http` |
| build | creates a production ready deployment |
| test | runs vitest in watch mode |
| coverage | runs vitest in coverage mode |
| format | formats all src and test files with prettier |
| lint | lints code using XO in autofix mode |
## Usage
Clone this starter using degit:
```bash
npx degit osdevisnot/node-starter my-app
```