Skip to content

docs: clarify how to run the component and the app locally#69

Merged
joanise merged 3 commits intomainfrom
dev.polish-readme
Feb 2, 2023
Merged

docs: clarify how to run the component and the app locally#69
joanise merged 3 commits intomainfrom
dev.polish-readme

Conversation

@joanise
Copy link
Copy Markdown
Member

@joanise joanise commented Feb 2, 2023

No description provided.

@joanise joanise requested a review from roedoejet February 2, 2023 17:58
Copy link
Copy Markdown
Collaborator

@roedoejet roedoejet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just small changes where my comment is - looks good though, thanks @joanise !

Comment thread README.md Outdated

#### Understanding where the components come from when you run locally

When you run `nx serve Studio-Web`, that process is actually serving all the components needed
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not exactly true - it's not serving them, it's just that nx build web-component puts the built components in the place that nx imports them (via the paths defined in the root tsconfig.base.json). I think "serve" is misleading because it makes it seem like we're putting them on a port somewhere or something.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Subtle, but OK. I've made a patch, let me know if it is better now.

@joanise
Copy link
Copy Markdown
Member Author

joanise commented Feb 2, 2023

@roedoejet I'll squash merge this PR if you are happy with it now.

@joanise joanise merged commit 21b0bbb into main Feb 2, 2023
@joanise joanise deleted the dev.polish-readme branch February 2, 2023 20:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants