Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peterthehan/typescript-bootstrap
An opinionated TypeScript bootstrap template.
https://github.com/peterthehan/typescript-bootstrap
bootstrap default eslint jest node node-js nodejs opinionated project template typescript
Last synced: 25 days ago
JSON representation
An opinionated TypeScript bootstrap template.
- Host: GitHub
- URL: https://github.com/peterthehan/typescript-bootstrap
- Owner: peterthehan
- License: mit
- Created: 2021-08-02T04:09:15.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-25T17:25:18.000Z (11 months ago)
- Last Synced: 2024-05-01T15:07:34.923Z (6 months ago)
- Topics: bootstrap, default, eslint, jest, node, node-js, nodejs, opinionated, project, template, typescript
- Language: TypeScript
- Homepage:
- Size: 700 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# TypeScript Bootstrap
An opinionated TypeScript bootstrap template.
## Getting started
1. Run the following commands to bootstrap a TypeScript project in your working directory:
> Replace `my-typescript-project` in the commands below with your own preferred project name!
```
npx degit peterthehan/typescript-bootstrap my-typescript-project
```
```
cd my-typescript-project/
```
```
npm i
```
2. You can run the following commands to verify your setup:
```
npm run lint && npm run build && npm test
```
View [package.json](./package.json) for more information.
You're ready to create your own TypeScript project! 🎉
## Reasoning
The following resources detail how the configurations in this `typescript-bootstrap` template were determined:
### Configs
- [.eslintrc.json](./.eslintrc.json)
- https://typescript-eslint.io/docs/#step-2-configuration
- https://github.com/prettier/eslint-plugin-prettier#recommended-configuration
- https://github.com/lydell/eslint-plugin-simple-import-sort
- https://github.com/mthadley/eslint-plugin-sort-destructure-keys
- https://github.com/leo-buneev/eslint-plugin-sort-keys-fix
- https://github.com/infctr/eslint-plugin-typescript-sort-keys
- [jest.config.json](./jest.config.json)
- https://kulshekhar.github.io/ts-jest/docs/getting-started/installation#jest-config-file
- [tsconfig.json](./tsconfig.json)
- https://www.bayanbennett.com/posts/stop-messing-with-tsconfig
### Actions
- [.github/dependabot.yml](./.github/dependabot.yml)
- https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
- [.github/workflows/codeql-analysis.yml](./.github/workflows/codeql-analysis.yml)
- https://github.com/github/codeql-action
- [.github/workflows/node.js.yml](./.github/workflows/node.js.yml)
- https://github.com/actions/starter-workflows/blob/main/ci/node.js.yml