baalajimaestro/personal-website
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

feat: update docs

Browse source
This commit is contained in:
kaivanwong 2024-05-06 10:59:07 +08:00
parent a8c4bd145f
commit adffb7c1e1
1 changed files with 51 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
README.md
View file

@ -21,19 +21,67 @@ If you just want to develop locally, you can [create a repo](https://github.com
Just run and visit http://localhost:1977.
```bash
pnpm dev
npn run dev
```
> Node.js version 18 or higher is required for this project.
To build the App, you can run:
```bash
pnpm build
npm run build
```
You will then see the `dist` folder generated for publishing, which you can preview locally with the following command.
```bash
pnpm preview
npm run preview
```
## Use pnpm / yarn
If you want to use pnpm or yarn as a package management tool, please refer to the following steps.
> If `preinstall` exists in `scripts`, remove it first.
### pnpm
Replace `"pre-commit": "npx lint-staged"` in package.json with `"pre-commit": "pnpm lint-staged"`.
And replace `"*": "npm run lint:fix"` with `"*": "pnpm lint:fix"`.
Like this:
```json
{
// ...
"simple-git-hooks": {
"pre-commit": "pnpm lint-staged"
},
"lint-staged": {
"*": "pnpm lint:fix"
}
}
```
### yarn
Replace `"pre-commit": "npx lint-staged"` in package.json with `"pre-commit": "yarn lint-staged"`.
And replace `"*": "npm run lint:fix"` with `"*": "yarn lint:fix"`.
Like this:
```json
{
// ...
"simple-git-hooks": {
"pre-commit": "yarn lint-staged"
},
"lint-staged": {
"*": "yarn lint:fix"
}
}
```
## License