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 22:21:18 +01:00
parent de8d37bce9
commit 4e819c93a1
1 changed files with 1 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Design:-Runnable-Project.md

@ -34,6 +34,7 @@ The package would provide an npm start script that runs node-red with the approp
It could also provide a `bin` section that could allow starting via command line if installed globally.
> 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.
### Runtime settings
@ -47,12 +48,6 @@ module.exports = {
}
```
### Credentials
When deploying a project, it may also need to have credentials provided. Normally when exporting flows we don't include credentials. By default everything in the projects folder including credentials will be included. How do we make it obvious to people they could be copying credentials externally ? Do we also include *cred.json in .gitignore/.npmignore by default ?
### Dockerfile
We should also have an example Dockerfile that can be used to build and run a project.