Skip to content

Commit

Permalink
Fix README.md and better npm script
Browse files Browse the repository at this point in the history
  • Loading branch information
ken-matsui committed Dec 27, 2023
1 parent f07f177 commit b62879c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 11 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,21 +23,17 @@ git clone https://github.com/hcp-uw/club-website.git
```
3) Go to `${HOME}/club-website/.`
```sh
cd {HOME}/club-website/
cd ${HOME}/club-website/
```
4) Install all dependencies using `yarn deps`
4) Install all dependencies using `yarn` (or `yarn install`)
```sh
yarn deps
yarn
```
<!-- 5) Run the application locally using `yarn run dev`
```sh
yarn run dev
``` -->

## Running the App Locally

```sh
yarn run dev
yarn dev
```

Runs the app in the development mode.\
Expand Down Expand Up @@ -75,10 +71,10 @@ To apply fixes:
yarn lint --apply
```

To apply suggested fixes:
To apply unsafe fixes:

```shell
yarn lint --apply-suggested
yarn lint --apply-unsafe
```

### Formatter
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"start": "next start",
"lint": "biome check .",
"fmt": "biome format . --write",
"deps": "yarn install; cd ./back_end; npm install; cd ..;"
"postinstall": "npm -C ./back_end install"
},
"dependencies": {
"@chakra-ui/react": "^2.5.1",
Expand Down

0 comments on commit b62879c

Please sign in to comment.