Skip to content

Commit

Permalink
doc(run-examples): Add documentation about how to run locally example…
Browse files Browse the repository at this point in the history
…s-ts project
  • Loading branch information
annelhote committed Aug 2, 2024
1 parent eddb4ab commit 37ddef1
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,26 @@
# dsfr-plus
Design system from the French state - React extended version


## Run examples locally

1. Build local version of the lib "dsfr-plus"

`npm run build`

2. Delete previous version of the lib "dsfr-plus" in "examples-ts" project

`rm -Rf example-ts/dist`

3. Copy local version of the lib "dsfr-plus" into the "examples-ts project"

`cp -R dist example-ts`

4. Run "examples-ts" project

`npm run example-ts`


## Deployment

To deploy in production, simply run this command from your staging branch :
Expand All @@ -9,4 +29,4 @@ To deploy in production, simply run this command from your staging branch :
npm run deploy --level=[patch|minor|major]
```

:warning: Obviously, only members of the [dataesr organization](https://github.com/dataesr/) have rights to push on the repo.
:warning: Obviously, only members of the [dataesr organization](https://github.com/dataesr/) have rights to push on the repo.
2 changes: 0 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
"dist"
],
"workspaces": [
"example",
"example-ts"
],
"scripts": {
Expand All @@ -27,7 +26,6 @@
"lint": "eslint src --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
"lint:fix": "eslint --fix 'src/**/*.{jsx,ts,tsx}'",
"preview": "vite preview",
"example": "npm run dev -w example",
"example-ts": "npm run dev -w example-ts"
},
"dependencies": {
Expand Down

0 comments on commit 37ddef1

Please sign in to comment.