Skip to content

Commit

Permalink
Merge branch 'master' into hotfix/add-safe-getter-for-potentially-und…
Browse files Browse the repository at this point in the history
…efined-ref
  • Loading branch information
KitoC authored Apr 3, 2024
2 parents 807c2a2 + a64f760 commit 613a263
Show file tree
Hide file tree
Showing 6 changed files with 352 additions and 2,149 deletions.
2 changes: 2 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
CONSUMERS=teamform-app-ui
WORKING_DIR=
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,5 @@ yarn-error.log*
/interplay/*/

.build_storybook

.env
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,17 @@ As an alternative to `npm link` you can run `npm run dist` and then copy the `es

`cp -R es/ ../../../team-directory/node_modules/orcs-design-system/`

This has now been added to a script with Nodemon.

To get it to work:

1. `cp .env.example .env`
2. OPTIONAL: Update WORKING_DIR in env if orcs resides in a different working directory to your project. Else-wise Orcs will assume the project is one level up from itself.
3. Add any projects to CONSUMERS in env separated by ',' (defaults with `CONSUMERS=teamform-app-ui`)
4. Run `npm run dev`.

Now you can make any changes in orcs and it will build and then copy the es from the build into your project's node_modules. Run `npm install` in your project dir if you want to revert to the npm installation.

### Symlinking with `npm link`

##### We haven't had much success with this recently
Expand Down
Loading

0 comments on commit 613a263

Please sign in to comment.