Skip to content

Commit c844a2c

Browse files
committed
more readme updates
- component library dev mode - exception handling
1 parent 6dcd3d1 commit c844a2c

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -98,28 +98,36 @@ yarn upgrade @scientist-softserv/webstore-component-library --latest
9898
#### Component Library Dev Mode
9999
Using the local github repository requires you to manually clone the component library to your computer, build, and link it:
100100

101-
Preparing your local copy of the component library:
101+
##### Preparing your local copy of the component library:
102+
_Prerequisite: clone the [webstore-component-library](https://github.com/scientist-softserv/webstore-component-library.git) and [get the app running](https://github.com/scientist-softserv/webstore-component-library#running-the-app)_
102103

103-
git clone https://github.com/scientist-softserv/webstore-component-library.git
104104
cd webstore-component-library
105-
npm install
106105
yarn link # now there is a magic symlink in `~/.config/yarn/link` usable by the webstore app
107106

108-
If there are changes to the component library, you will need to rebuild in order to get the newest changes. You can either rebuild manually after changes are made, or have the webstore continually "watch" for changes:
107+
Choose one of the below:
109108

110-
npm run build-lib # for a onetime build
111-
npm run watch-lib # for a continuous build
109+
npm run build-lib # must be run every time you want a change to show in the webstore
110+
npm run watch-lib # run once and the wcl will watch for changes
112111

113-
Back in your webstore checkout:
112+
##### Preparing your local copy of the webstore:
114113

114+
# run in a separate terminal window than where the wcl is
115+
cd webstore
115116
yarn link "@scientist-softserv/webstore-component-library"
117+
yarn remove @scientist-softserv/webstore-component-library
118+
(restart the dev server)
116119

117-
and your `webstore` will start using the local component build.
118-
119-
If you are using a local version of the component library, you will need to temporarily delete the line `"@scientist-softserv/webstore-component-library": "VERSION_HERE",` from the `package.json` file in order to see your local changes as opposed to pulling from the github package.
120+
##### Return to using the packaged version of the webstore-component-library:
121+
# in the webstore repository
122+
yarn unlink "@scientist-softserv/webstore-component-library"
123+
git checkout package.json yarn.lock
124+
yarn install --check-files --force
125+
(restart the dev server)
120126

121127
## Exception Handling
122-
<!-- TODO: add sentry details -->
128+
The application is configured to use Sentry. Refer to ".env.development.example" for how to find the necessary variables.
129+
130+
If any other exception handler is desired, it will require configuration.
123131

124132
## Linting
125133
``` bash

0 commit comments

Comments
 (0)