https://github.com/aturingmachine/ts-template
Template for typescript projects using my own personal preffered configs.
https://github.com/aturingmachine/ts-template
Last synced: 11 months ago
JSON representation
Template for typescript projects using my own personal preffered configs.
- Host: GitHub
- URL: https://github.com/aturingmachine/ts-template
- Owner: aturingmachine
- Created: 2021-08-29T18:23:36.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-29T18:27:45.000Z (over 4 years ago)
- Last Synced: 2025-02-04T00:35:46.858Z (about 1 year ago)
- Language: JavaScript
- Size: 102 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Typescript Template
Template for making Typescript projects, has my preferred configurations.
## Using this template
```sh
# Clone the template
git clone git@github.com:aturingmachine/ts-template.git
# Run the init script
npm run setup
# Optionally pass p|pretty to colorize output
npm run setup pretty
# Follow the script's prompts
# Run the project
npm run dev
```
## Template Configuration
### Runtime
- Node v12.13.0 for modules
- Node v16.3.0 for projects
### Testing
- jest
- ts-jest
### Linting
- prettier
- eslint
- @typescript-eslint/eslint-plugin
- @typescript-eslint/parser
- eslint-config-prettier
- eslint-plugin-import
- eslint-plugin-prettier
- eslint
- jest
### Scripts
```js
scripts: {
"build": "tsc",
"dev": "npm run build && node dist/index.js",
"lint": "eslint",
"lint:fix": "eslint --fix",
"test": "jest"
// Only for modules
"prepublishOnly": "npm run build",
}
```