Skip to content

Commit a47c8a8

Browse files
committed
Update documentation
1 parent 4144c53 commit a47c8a8

File tree

3 files changed

+34
-22
lines changed

3 files changed

+34
-22
lines changed

.github/dependabot.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ updates:
99
docker:
1010
patterns:
1111
- "*"
12-
- package-ecosystem: npm
12+
- package-ecosystem: pnpm
1313
directory: "/"
1414
schedule:
1515
interval: "monthly"

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,38 +3,50 @@
33
Seed project for typescript.
44
Use this repository as a template for your typescript projects.
55

6+
## Prerequisites
7+
8+
This project uses pnpm as the package manager. If you don't have pnpm installed, you can install it using one of the following methods:
9+
10+
### Install pnpm globally via npm
11+
12+
```bash
13+
npm install -g pnpm
14+
```
15+
16+
For other installation methods, visit: https://pnpm.io/installation
17+
618
## Getting Started
719

820
Install the dependencies:
921

1022
```bash
11-
npm install
23+
pnpm install
1224
```
1325

1426
Build the project:
1527

1628
```bash
17-
npm run build
29+
pnpm run build
1830
```
1931

2032
Run the project:
2133

2234
```bash
23-
npm start
35+
pnpm start
2436
```
2537

2638
Test the project using *Jest*:
2739

2840
```bash
29-
npm test
41+
pnpm test
3042
# To test and display the coverage
31-
npm test:cov
43+
pnpm test:cov
3244
```
3345

3446
Lint the project using *ESLint*:
3547

3648
```bash
37-
npm run lint
49+
pnpm run lint
3850
# To fix the linting errors
39-
npm run lint:fix
51+
pnpm run lint:fix
4052
```

pnpm-lock.yaml

Lines changed: 14 additions & 14 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)