Skip to content
This repository was archived by the owner on Jul 16, 2020. It is now read-only.

Update README.md #247

Open
jorgevgut wants to merge 1 commit into
base: development
Choose a base branch
from
Open

Update README.md #247

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,21 @@ The following fields will determine how the Ciao Web UI will beconfigured.

#### Building application

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.
Copy link

@markdryan markdryan Jan 18, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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'.

Copy link
Contributor

@arturonuman arturonuman Jan 23, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree, it's more clear.


Copy link

@markdryan markdryan Jan 18, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor

@arturonuman arturonuman Jan 23, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix is already in development branch.

###### make install
Use 'make' or 'make install' in order to build ciao-webui application with latest 'production' ready code.

Copy link

@markdryan markdryan Jan 18, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't really understand the difference between make install and make install-dev from reading these two paragraphs.

  1. Does make install recompile the code?
  2. If it doesn't download the dependencies how does it build? Does it use a vendored version of the dependencies?
  3. What do you mean by 'production' here? Are you referring to the NODE_ENV?
  4. If do build using make install can I specify development when running deploy?

Copy link
Contributor Author

@jorgevgut jorgevgut Jan 18, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

@arturonuman arturonuman Jan 23, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess it will be better to replace 'build' with 'install' as make install does not actually build any code.

###### make install-dev
Use 'make install-dev' to install development dependencies and fully build and update dependencies for the Ciao-Webui project. Use this target for development environments.

###### make uninstall
Remove Ciao-Webui from the system and cleans build files.

###### make clean
Clean build generated files from working directory.
**Note:** Use this target to clean the working directory after runnin 'make install-dev' target.

# install while setting a "development" environment
$ ./install.sh development
# In this case NODE_ENV will be set to "development"

#### Running application:

Expand Down