Skip to content

Commit

Permalink
Merge pull request #1332 from undp/1331-update-patching-workflow-to-a…
Browse files Browse the repository at this point in the history
…pply-only-to-windows-environments

#1331 - decoupled patching to the separate command and updated docume…
  • Loading branch information
Jura authored Jul 12, 2024
2 parents c022212 + cd44aa2 commit c63bf15
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Living Style Guide & Documentation: **[Demo](https://design.undp.org)**
npm install @undp/design-system
```
See Starter project at the link below for details of implementaiton

## Starter project

Static generator using Design System as dependency: [UNDP Design System starter template](https://github.com/undp/design-system-starter-template)
Expand All @@ -35,6 +36,10 @@ git clone
# install project dependencies
npm install

# In Windows environment apply patch to the mdx1-csf plugin.
# This can be omitted when this PR is merged: https://github.com/storybookjs/mdx1-csf/pull/27
npm run windows-patch-package

# runs storybook locally
npm run storybook

Expand All @@ -43,10 +48,6 @@ npm run build-storybook

# build compiled css and js
npm run build

# linting on codebase
# caution: this will write changes to your files
npm run lint
```

### Important
Expand Down
11 changes: 5 additions & 6 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"build": "webpack --progress",
"storybook": "storybook dev -p 6006",
"build-storybook": "storybook build --loglevel verbose",
"postinstall": "patch-package"
"windows-patch-package": "patch-package"
},
"keywords": [
"UNDP",
Expand Down

0 comments on commit c63bf15

Please sign in to comment.