https://github.com/proxitystudios/typescript-starter
I promise it won't hurt you. Just use it.
https://github.com/proxitystudios/typescript-starter
boilerplate typescript typescript-starter typescript-starter-template
Last synced: about 1 year ago
JSON representation
I promise it won't hurt you. Just use it.
- Host: GitHub
- URL: https://github.com/proxitystudios/typescript-starter
- Owner: ProxityStudios
- License: mit
- Created: 2023-01-07T20:53:55.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-25T20:37:49.000Z (almost 2 years ago)
- Last Synced: 2024-08-25T21:50:56.151Z (almost 2 years ago)
- Topics: boilerplate, typescript, typescript-starter, typescript-starter-template
- Language: TypeScript
- Homepage:
- Size: 370 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# [Typescript Starter](https://github.com/ProxityStudios/typescript-starter)
I promise it won't hurt you. **Just use it.**
## Included Packages
- `dotenv`: `^16.4.5`
- `rotating-file-stream`: `^3.2.3`
- `tslog`: `^4.9.3`
- `yargs`: `^17.7.2`
## Included Dev Packages
- `@types/node`: `^20.14.9`
- `@types/yargs`: `^17.0.32`
- `@typescript-eslint/eslint-plugin`: `^7.15.0`
- `@typescript-eslint/parser`: `^7.15.0`
- `eslint`: `^8.57.0`
- `eslint-config-airbnb-base`: `^15.0.0`
- `eslint-config-airbnb-typescript`: `^18.0.0`
- `eslint-config-prettier`: `^9.1.0`
- `eslint-plugin-import`: `^2.29.1`
- `eslint-plugin-prettier`: `^5.1.3`
- `npm-run-all`: `^4.1.5`
- `prettier`: `^3.3.2`
- `rimraf`: `^5.0.7`
- `ts-node-dev`: `^2.0.0`
- `typescript`: `^5.5.3`
## Recommended Extensions
- Extension named: `prettier` (`esbenp.prettier-vscode`)
- Extension named: `eslint` (`dbaeumer.vscode-eslint`)
## Scripts
### Start the project
_You must build the project in order to start_
```
npm run start
```
### Start the project in development environment
```
npm run dev
```
### Clean the compiled code and build
```
npm run build
```
### Don't clean the compiled code and build
```
npm run build:tsc
```
### Clean the compiled code
```
npm run clean-dist
```
### Format the code
```
npm run format
```
## Guides
### Setup Guide
1. Install dependencies by using [this](#installscript) script
2. Rename file `.env.development example` to `.env.development`
3. Start by using [this](#startdevelopment) script
4. Code somethings...
#### Production Usage
1. Build by using [this](#build) script
2. Rename file `.env example` to `.env`
3. Start by using [this](#start) script
## License
This project licensed with `MIT` license