Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nicksp/typescript-node-starter
A minimal boilerplate for TypeScript and Node.js applications
https://github.com/nicksp/typescript-node-starter
boilerplate eslint husky-hooks jest jest-tests nodejs prettier starter-kit typescript
Last synced: 10 days ago
JSON representation
A minimal boilerplate for TypeScript and Node.js applications
- Host: GitHub
- URL: https://github.com/nicksp/typescript-node-starter
- Owner: nicksp
- License: mit
- Created: 2022-09-18T22:41:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-09-20T12:33:18.000Z (over 2 years ago)
- Last Synced: 2024-11-10T14:43:14.570Z (2 months ago)
- Topics: boilerplate, eslint, husky-hooks, jest, jest-tests, nodejs, prettier, starter-kit, typescript
- Language: JavaScript
- Homepage:
- Size: 103 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TypeScript Node Starter
A minimal boilerplate for Node.js web applications written in TypeScript 📦
Includes:
- [Typescript](https://www.typescriptlang.org/) - JavaScript that scales
- [TypeScript ESLint](https://typescript-eslint.io/docs/) - source code linter
- [Prettier](https://prettier.io/) - an opinionated code formatter
## Prerequisites
To build and run this app locally you will need a few things:
- Install [Node.js](https://nodejs.org/en/)
- Install [VS Code](https://code.visualstudio.com/)
## Getting started
- Clone the repository
```bash
git clone --depth=1 [email protected]:nicksp/typescript-node-starter.git
```
- Install dependencies
```bash
cd
npm install
```
- Generate production build and run the project
```bash
npm start
```
- Local development with cold reloading
```bash
npm run dev
```
- Linting
```bash
npm run lint
npm run lint:fix
```
- Code formatting
```bash
npm run pretty
npm run pretty:fix
```
- Testing
```bash
npm test
```
## Sources
#### Official TypeScript-Node-Starter:
https://github.com/Microsoft/TypeScript-Node-Starter
#### The definitive guide to TypeScript
https://basarat.gitbook.io/typescript/
## License
Copyright (c) Nick S. Khan. All rights reserved.
Licensed under the [MIT](LICENSE) License.