Skip to content

Commit bb90692

Browse files
JavierCaneismanapa
andcommitted
doc: update readme instructions removing web related references
Co-authored-by: ismanapa <[email protected]>
1 parent 57af383 commit bb90692

File tree

1 file changed

+20
-45
lines changed

1 file changed

+20
-45
lines changed

README.md

Lines changed: 20 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,8 @@
1-
# TypeScript Skeleton (base / project starter)
1+
# 🔷🌱 TypeScript Skeleton
22

3-
Repository intended to serve as a starting point if you want to bootstrap a project in TypeScript.
3+
Template intended to serve as a starting point if you want to bootstrap a project in TypeScript.
44

5-
The intention with this repository is to leave it with the bare minimum dependencies and tools needed to run TypeScript snippets or start you projects without any opinionated decision already made.
6-
7-
However, if you want an opinionated TypeScript skeleton we also have the following alternatives ready for different purposes:
8-
9-
- [🔷🕸️ TypeScript Web Skeleton](https://github.com/CodelyTV/typescript-web-skeleton)
10-
- [🔷🌍 TypeScript API Skeleton](https://github.com/CodelyTV/typescript-api-skeleton)
11-
- [🔷✨ TypeScript DDD Skeleton](https://github.com/CodelyTV/typescript-ddd-skeleton)
12-
13-
If you want this very same skeleton philosophy but with other languages we have you covered also 😊:
14-
15-
- [✨ JavaScript Basic Skeleton](https://github.com/CodelyTV/javascript-basic-skeleton)
16-
- [☕ Java Basic Skeleton](https://github.com/CodelyTV/java-basic-skeleton)
17-
- [📍 Kotlin Basic Skeleton](https://github.com/CodelyTV/kotlin-basic-skeleton)
18-
- [🧬 Scala Basic Skeleton](https://github.com/CodelyTV/scala-basic-skeleton)
19-
- [🦈 C# Basic Skeleton](https://github.com/CodelyTV/csharp-basic-skeleton)
20-
- [🐘 PHP Basic Skeleton](https://github.com/CodelyTV/php-basic-skeleton)
5+
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.
216

227
## Features
238

@@ -26,41 +11,31 @@ If you want this very same skeleton philosophy but with other languages we have
2611
- [ESLint](https://eslint.org/) with:
2712
- [Simple Import Sort](https://github.com/lydell/eslint-plugin-simple-import-sort/)
2813
- [Import plugin](https://github.com/benmosher/eslint-plugin-import/)
29-
- [HTML plugin](https://github.com/BenoitZugmeyer/eslint-plugin-html)
3014
- And a few other ES2015+ related rules
3115
- [Jest](https://jestjs.io) with [DOM Testing Library](https://testing-library.com/docs/dom-testing-library/intro)
3216
- [GitHub Action workflows](https://github.com/features/actions) set up to run tests and linting on push
17+
- [SWC](https://swc.rs/): Execute your tests in less than 200ms
3318

3419
## Running the app
3520

36-
```
37-
# install dependencies
38-
npm install
21+
- Install the dependencies: `npm install`
22+
- Execute the tests: `npm run test`
23+
- Check linter errors: `npm run lint`
24+
- Fix linter errors: `npm run lint:fix`
3925

40-
# run in dev mode on port 8080
41-
npm run dev
26+
## Related skeleton templates
4227

43-
# generate production build
44-
npm run build
28+
Opinionated TypeScript skeletons ready for different purposes:
4529

46-
# run generated content in dist folder on port 8080
47-
npm run start
48-
```
49-
50-
## Testing
51-
52-
### Jest with Testing Library
53-
54-
```
55-
npm run test
56-
```
57-
58-
## Linting
30+
- [🔷🕸️ TypeScript Web Skeleton](https://github.com/CodelyTV/typescript-web-skeleton)
31+
- [🔷🌍 TypeScript API Skeleton](https://github.com/CodelyTV/typescript-api-skeleton)
32+
- [🔷✨ TypeScript DDD Skeleton](https://github.com/CodelyTV/typescript-ddd-skeleton)
5933

60-
```
61-
# run linter
62-
npm run lint
34+
This very same basic skeleton philosophy implemented in other programming languages:
6335

64-
# fix lint issues
65-
npm run lint:fix
66-
```
36+
- [✨ JavaScript Basic Skeleton](https://github.com/CodelyTV/javascript-basic-skeleton)
37+
- [☕ Java Basic Skeleton](https://github.com/CodelyTV/java-basic-skeleton)
38+
- [📍 Kotlin Basic Skeleton](https://github.com/CodelyTV/kotlin-basic-skeleton)
39+
- [🧬 Scala Basic Skeleton](https://github.com/CodelyTV/scala-basic-skeleton)
40+
- [🦈 C# Basic Skeleton](https://github.com/CodelyTV/csharp-basic-skeleton)
41+
- [🐘 PHP Basic Skeleton](https://github.com/CodelyTV/php-basic-skeleton)

0 commit comments

Comments
 (0)