Update README.md #247
Update README.md #247
Conversation
Update readme file to include instructions on building ciao-webui with the provided Makefile. Remove instructions regarding install.sh script, as it is outdated. Signed-off-by: Jorge Villalobos <[email protected]>
| In order to build application the 'install.sh' must be executed. This script will intsall dependencies using the npm package manager and also build minified JS scripts used with browser compatibility. | ||
| Note: this process is only necessary for development as minified scripts and dependencies are already provided by the application. | ||
| In order to build the application a Makefile is provided. Use make 'TARGET' to build Ciao-Webui. When running either 'install' or 'install-dev' targets. Note that if not set, the environment variable 'NODE_ENV' will be set to 'production' by default. | ||
|
|
There was a problem hiding this comment.
Are we planning to fix #129 any time soon? If not, we should add that npm install d3-scale needs to be run before make install-dev. Is this also needed for make install?
There was a problem hiding this comment.
Fix is already in development branch.
|
|
||
| In order to build application the 'install.sh' must be executed. This script will intsall dependencies using the npm package manager and also build minified JS scripts used with browser compatibility. | ||
| Note: this process is only necessary for development as minified scripts and dependencies are already provided by the application. | ||
| In order to build the application a Makefile is provided. Use make 'TARGET' to build Ciao-Webui. When running either 'install' or 'install-dev' targets. Note that if not set, the environment variable 'NODE_ENV' will be set to 'production' by default. |
There was a problem hiding this comment.
Use make 'TARGET' to build Ciao-Webui. When running either 'install' or 'install-dev' targets.
I'd reword slightly
Use make 'TARGET' to build Ciao-Webui, where TARGET can be either 'install' or 'install-dev'.
There was a problem hiding this comment.
Agree, it's more clear.
|
|
||
| ###### make install | ||
| Use 'make' or 'make install' in order to build ciao-webui application with latest 'production' ready code. | ||
|
|
There was a problem hiding this comment.
I don't really understand the difference between make install and make install-dev from reading these two paragraphs.
- Does make install recompile the code?
- If it doesn't download the dependencies how does it build? Does it use a vendored version of the dependencies?
- What do you mean by 'production' here? Are you referring to the NODE_ENV?
- If do build using make install can I specify development when running deploy?
There was a problem hiding this comment.
Hi @markdryan yes, the difference is that make install does not recompile js code, make install-dev does, I'll reword to make it more understandable. Thanks
There was a problem hiding this comment.
I guess it will be better to replace 'build' with 'install' as make install does not actually build any code.
3 participants
Update readme file to include instructions on building ciao-webui
with the provided Makefile.
Remove instructions regarding install.sh script, as it is outdated.
Closes #246
Signed-off-by: Jorge Villalobos [email protected]