Skip to content

Commit

Permalink
docs(contributing): update first setup instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ivangabriele committed Jun 20, 2024
1 parent cae3ef5 commit 0506aea
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
5 changes: 4 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,12 @@
git clone https://github.com/MTES-MCT/monitor-ui.git
cd monitor-ui
yarn
yarn dev:setup # Install Git hooks
yarn postinstall # Optional: automatically run each time Yarn cache is cleared
```

> [!NOTE]
> You may have to manually run `yarn postinstall` to update post-install scripts when Yarn cache already exists.
### Local Development

```sh
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@
"build:type": "tsc -p ./tsconfig.dist.json",
"clean": "yarn build:clean && rm -Rf ./node_modules/.cache && rm -Rf ./node_modules/.vite",
"dev": "storybook dev --no-open -p 6006",
"dev:setup": "sh ./scripts/dev/setup.sh",
"serve": "http-server ./storybook-static --port 3000 --silent",
"start": "storybook dev -p 6006",
"icons": "yarn icons:clean && yarn icons:generate && yarn icons:lint",
"icons:clean": "rm -Rf ./src/icons && mkdir ./src/icons",
"icons:generate": "node ./scripts/icons/generateIcons.js",
"icons:lint": "echo 'Linting generated icons…' && yarn eslint --fix ./src/icons && echo 'Done.'",
"postinstall": "husky",
"preview": "echo 'Linting generated icons…' && yarn eslint --fix ./src/icons && echo 'Done.'",
"test": "yarn test:lint && yarn test:type",
"test:e2e": "yarn cypress run --browser firefox --config-file ./config/cypress.config.ts --component",
Expand Down
4 changes: 0 additions & 4 deletions scripts/dev/setup.sh

This file was deleted.

0 comments on commit 0506aea

Please sign in to comment.