Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add commands to install all dependencies and run docs site from root #16

Merged
merged 2 commits into from
Feb 28, 2024

Conversation

mrderyk
Copy link
Contributor

@mrderyk mrderyk commented Feb 28, 2024

CONTEXT

The docs site is now a separate app due to how React-Chatbot is built. We need to allow devs to perform relevant npm commands from one location- the root directory.

CHANGES

  • add installAllDependencies command to install deps for chatbot, build it, then install built package as docs site dependency
  • add docs command that can be run from the root directory

Copy link

github-actions bot commented Feb 28, 2024

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-02-28 22:28 UTC

Copy link
Contributor

@cjcenizal cjcenizal left a comment

Choose a reason for hiding this comment

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

Thanks for doing this! Good improvement to the DX. I left one comment about how I think we can make it a bit better.

package.json Outdated
"test": "jest --coverage"
"test": "jest --coverage",
"installAllDependencies": "npm install && npm run build && npm install --prefix docs",
"docs": "npm run docs --prefix docs"
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we just combine these two? I tried it locally and it's a nice DX. I don't think there's much time saved by splitting out the two commands.

"docs": "npm install && npm run build && npm install --prefix docs && npm run docs --prefix docs"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mrderyk mrderyk merged commit 5d65610 into main Feb 28, 2024
4 checks passed
@mrderyk mrderyk deleted the chore/update_dev_env_process branch February 28, 2024 22:28
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