frodovdr
/
node-red
mirror of https://github.com/node-red/node-red.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Design: Runnable Project (markdown)

Dave Conway-Jones 2018-04-05 23:20:59 +01:00
parent 4e819c93a1
commit 45c7e25251
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Design:-Runnable-Project.md

@ -36,6 +36,8 @@ It could also provide a `bin` section that could allow starting via command line
> DCJ: If you run the steps above then node-red and other modules will be installed *below* the CWD in node_modules... all good. If however we want to take our project dir and npm pack it... on re-installing it the project itself will also be in the node_modules dir thus making npm start (or pathing back to node-red) trickier.
Another possibility would be to add a bin section to package.json - but that requires a command to be run (and doesn't take parameters) so in order to do that we would also need to create that script/.js file or porvide a template.
> DCJ: Actually by pre-req node-red it automatically adds the node-red command to the node_modules/.bin so the package.json start script can just call node-red and all is good.
### Runtime settings
When deploying the project, there will also be a need to have the runtime settings provided. These are not normally part of a project generated by Node-RED. The question is whether we have some tooling support to generate, or we just document how to do it. For example, the user would manually add a `settings.js` file to their project repo.