Add `npm link` stuff to the README

This commit is contained in:
mike cullerton 2022-11-16 11:11:44 -05:00
parent 950bf4663d
commit e4031b69bf
1 changed files with 31 additions and 0 deletions

View File

@ -12,6 +12,37 @@ Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app w
You can also user `npm run start:dev` to get a dev server with lazy loading. This makes development much more efficient
## Development server
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
## Local Development with Sartography Libraries
If you are making changes to the Sartography Libraries dependency, you
can use npm link to connect the two systems.
On the library side, run
```bash
ng build --watch
```
Then create a link to the built values by cd'ing into the dist directory (in a new terminal, leave the build above running)
```bash
cd sartography-libraries/dist/sartography-workflow-lib
npm link
```
On the frontend code, link to the sartgraph-workflow-lib:
```bash
npm link sartography-workflow-lib
ng serve
```
Also note that you may need to add
```json
"preserveSymlinks": true
```
to your angular.json file in build/options.
At this point any changes you make to the shared libraries should be immediately reflected in your locally running front end.
## Code scaffolding
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.