Skip to content

Commit

Permalink
Client readme updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
dannon committed Dec 12, 2018
1 parent 0b0c008 commit e173bc5
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions client/README.md
Expand Up @@ -26,7 +26,7 @@ There are many moving parts to the client build system, but the entrypoint for
most people is the 'client' rule in the Makefile at the root of the Galaxy
repository. Execute the following to perform a complete build suitable for
local development, including dependency staging, style building, script
processing and bundling. This is a development-specific build which includes
processing, and bundling. This is a development-specific build which includes
extra debugging features, and excludes several production optimizations made
during the build process.

Expand Down Expand Up @@ -57,19 +57,21 @@ This will first stage any dependencies (yarn-installed packages like jquery,
etc), and then will watch for changes in any of the galaxy client source files.
When a file is changed, the client will automatically rebuild, after which you
can usually force refresh your browser to see changes. Note that it is still
recommended to run 'make client' after you are finished actively developing
using 'make client-watch'.
recommended to run `make client` after you are finished actively developing
using `make client-watch`.


Changing Styles/CSS
===================

The CSS and styling used by Galaxy is also controlled from this directory.
Galaxy uses Sass for its styling, a superset of CSS that compiles to CSS. Sass
files are kept in client/galaxy/style/scss. Compiled CSS is in
static/style/blue.
Galaxy uses Sass for its styling, which is a a superset of CSS that compiles
down to regular CSS. Most Galaxy styling source (.scss) files are kept in
`client/galaxy/style/scss. There are additionally style blocks alongside some
Vue components -- styles that are particular to that individual component and
do not apply site-wide.

As mentioned above, 'make client' will also rebuild styles. If you *only* want
to run the style task, use the following command from the `client` directory:
On build, the compiled css bundle is served at `/static/style/base.css`.

yarn run style
As mentioned above, `make client` will rebuild styles, as a part of the webpack
build. For iterative development, "Watch Mode" rebuilds as described above do
include style changes.

0 comments on commit e173bc5

Please sign in to comment.