README for users of this tool#53
Conversation
| Start the development server: | ||
|
|
||
| ```bash | ||
| cave view <filepath> |
There was a problem hiding this comment.
This works with the --console flag (stdout) but results in this error otherwise:
"npm error Missing script: "dev"
| cd clean-architecture-visualizer | ||
| npm install | ||
| npm run build | ||
| npm link |
There was a problem hiding this comment.
I tried following this and it fails at the npm link step:
@matt-dahlgren is this the expected behavior right now?
There was a problem hiding this comment.
Yes it is.
npm link is used for local development (so that we can test our cli locally without needing to publish/fully download a package) as seen here in the documentation.
I will be addressing how to properly download cave on my next task in documentation. But we are going to deploy it similarly as MemoryViz is deployed.
If you see here it is an npm download of the repo itself. This change will include a small addition of a package.json to the outermost layer of this project. But it will allow for faster bug changes.
TLDR: npm link is used in development, it is not useable in production as it is looking for a local directory to build.
4 participants
Proposed Changes
A README.md file with installation, setup, and execution instructions for people who want to run this tool.
Closes #20.)
...
Screenshots of your changes (if applicable)
Type of Change
(Write an
Xor a brief description next to the type or types that best describe your changes.)Checklist
(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the
[ ]into a[x]in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)Before opening your pull request:
After opening your pull request:
Questions and Comments
(Include any questions or comments you have regarding your changes.)