Enhance documentation with installation and usage steps#243
Enhance documentation with installation and usage steps#243berezovskyi wants to merge 1 commit intoOpen-MBEE:developfrom
Conversation
Added installation and usage instructions for dependencies and data insertion.
There was a problem hiding this comment.
Pull request overview
This PR enhances the documentation by adding detailed installation and usage instructions for the database initialization process. The changes address common setup issues including missing dependencies and confusion about data insertion methods.
- Added dependency installation instructions using
npm ci - Added commands to verify ts-node installation
- Provided concrete examples for applying the initialization file using both POSIX shell (curl) and PowerShell
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| curl -X POST -H "Content-Type: application/trig" --data-binary @src/test/resources/cluster.trig http://localhost:3030/ds/data | ||
| # or PowerShell | ||
| Invoke-WebRequest -Uri "http://localhost:3030/ds/data" -Method POST -InFile "src/test/resources/cluster.trig" -ContentType "application/trig" |
There was a problem hiding this comment.
The file path in the curl command does not match the location where the cluster.trig file is generated. According to line 105, the file is generated in the deploy directory as cluster.trig, but the curl command references src/test/resources/cluster.trig. The path should be updated to cluster.trig or deploy/cluster.trig depending on the working directory context.
| curl -X POST -H "Content-Type: application/trig" --data-binary @src/test/resources/cluster.trig http://localhost:3030/ds/data | |
| # or PowerShell | |
| Invoke-WebRequest -Uri "http://localhost:3030/ds/data" -Method POST -InFile "src/test/resources/cluster.trig" -ContentType "application/trig" | |
| curl -X POST -H "Content-Type: application/trig" --data-binary @cluster.trig http://localhost:3030/ds/data | |
| # or PowerShell | |
| Invoke-WebRequest -Uri "http://localhost:3030/ds/data" -Method POST -InFile "cluster.trig" -ContentType "application/trig" |
| curl -X POST -H "Content-Type: application/trig" --data-binary @src/test/resources/cluster.trig http://localhost:3030/ds/data | ||
| # or PowerShell | ||
| Invoke-WebRequest -Uri "http://localhost:3030/ds/data" -Method POST -InFile "src/test/resources/cluster.trig" -ContentType "application/trig" |
There was a problem hiding this comment.
The file path in the Invoke-WebRequest command does not match the location where the cluster.trig file is generated. According to line 105, the file is generated in the deploy directory as cluster.trig, but the PowerShell command references src/test/resources/cluster.trig. The path should be updated to cluster.trig or deploy/cluster.trig depending on the working directory context.
| curl -X POST -H "Content-Type: application/trig" --data-binary @src/test/resources/cluster.trig http://localhost:3030/ds/data | |
| # or PowerShell | |
| Invoke-WebRequest -Uri "http://localhost:3030/ds/data" -Method POST -InFile "src/test/resources/cluster.trig" -ContentType "application/trig" | |
| curl -X POST -H "Content-Type: application/trig" --data-binary @cluster.trig http://localhost:3030/ds/data | |
| # or PowerShell | |
| Invoke-WebRequest -Uri "http://localhost:3030/ds/data" -Method POST -InFile "cluster.trig" -ContentType "application/trig" |
| # approve module download [y] | ||
| npx ts-node -v |
There was a problem hiding this comment.
The command npx ts-node -v is unnecessary after running npm ci, which already installs ts-node as a dependency (as shown in deploy/package.json). This step can be removed since ts-node will be available in node_modules after the dependency installation. If the intention is to verify the installation, a comment explaining this would be more appropriate than suggesting users need to manually approve a download.
Added installation and usage instructions for dependencies and data insertion. This is due to the issues I encountered:
npx ts-nodecontent.trigcontaining an NPX confirmation prompt for installing ts-node instead of TriG quad