https://github.com/corbaz/typescript-basic-skeleton
typescript-basic-skeleton
https://github.com/corbaz/typescript-basic-skeleton
Last synced: 8 months ago
JSON representation
typescript-basic-skeleton
- Host: GitHub
- URL: https://github.com/corbaz/typescript-basic-skeleton
- Owner: corbaz
- License: mit
- Created: 2022-12-03T12:25:17.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-03T12:25:20.000Z (over 3 years ago)
- Last Synced: 2025-02-09T01:39:43.266Z (over 1 year ago)
- Language: TypeScript
- Size: 27.3 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# π·π± TypeScript Basic Skeleton
Template intended to serve as a starting point if you want to bootstrap a project in TypeScript.
The purpose of this repository is to leave it with the bare minimum dependencies and tools needed to run TypeScript snippets or start you project without any opinionated decision already made.
## Features
- [TypeScript](https://www.typescriptlang.org/) (v4)
- [Prettier](https://prettier.io/)
- [ESLint](https://eslint.org/) with:
- [Simple Import Sort](https://github.com/lydell/eslint-plugin-simple-import-sort/)
- [Import plugin](https://github.com/benmosher/eslint-plugin-import/)
- And a few other ES2015+ related rules
- [Jest](https://jestjs.io) with [DOM Testing Library](https://testing-library.com/docs/dom-testing-library/intro)
- [GitHub Action workflows](https://github.com/features/actions) set up to run tests and linting on push
- [SWC](https://swc.rs/): Execute your tests in less than 200ms
## Running the app
- Install the dependencies: `npm install`
- Execute the tests: `npm run test`
- Check linter errors: `npm run lint`
- Fix linter errors: `npm run lint:fix`
## Related skeleton templates
Opinionated TypeScript skeletons ready for different purposes:
- [π·πΈοΈ TypeScript Web Skeleton](https://github.com/CodelyTV/typescript-web-skeleton)
- [π·π TypeScript API Skeleton](https://github.com/CodelyTV/typescript-api-skeleton)
- [π·β¨ TypeScript DDD Skeleton](https://github.com/CodelyTV/typescript-ddd-skeleton)
This very same basic skeleton philosophy implemented in other programming languages:
- [β¨ JavaScript Basic Skeleton](https://github.com/CodelyTV/javascript-basic-skeleton)
- [β Java Basic Skeleton](https://github.com/CodelyTV/java-basic-skeleton)
- [π Kotlin Basic Skeleton](https://github.com/CodelyTV/kotlin-basic-skeleton)
- [𧬠Scala Basic Skeleton](https://github.com/CodelyTV/scala-basic-skeleton)
- [π¦ C# Basic Skeleton](https://github.com/CodelyTV/csharp-basic-skeleton)
- [π PHP Basic Skeleton](https://github.com/CodelyTV/php-basic-skeleton)