Skip to content
This repository has been archived by the owner on Feb 5, 2021. It is now read-only.

Commit

Permalink
HID-1804: set node version, ignore generated assets, update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rupl committed Jun 17, 2019
1 parent 68b5862 commit 64898fa
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 9 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
dist/
node_modules/
src/bower_components
src/app/common/translations.js
Expand Down
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
8.11.3
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@
* Switch to the dev branch `git checkout dev`
* Install node modules with yarn `yarn install`
* Add the local url to your hosts file:
on Mac: `sudo vi /etc/hosts`
Add `127.0.0.1 app.hid.vm`
* macOS: `sudo vi /etc/hosts`, then add `127.0.0.1 app.hid.vm`
* Run the Grunt tasks `grunt`
(Note to set you local environment to use the staging api use `grunt --target="dev"`)

Expand Down Expand Up @@ -122,13 +121,9 @@ As Test Admin E2E User:

## Front end

### Styleguide and pattern library

The styleguide and pattern library is available at https://un-ocha.github.io/styleguide/hid/

### CSS

This project uses [Sass](http://sass-lang.com/)
This project uses [Sass](https://sass-lang.com/)

Run `grunt watch` to watch for changes and rebuild the css.

Expand All @@ -138,7 +133,7 @@ Run `grunt watch` to watch for changes and rebuild the css.

Global styles, such as resets and grid styles, should be added to `app/common`.

Any _*.scss file in `app/common` (excluding sub-directories) will be automatically added to the CSS build.
Any `_*.scss` file in `app/common` (excluding sub-directories) will be automatically added to the CSS build.

##### Variables and mixins

Expand All @@ -148,4 +143,4 @@ As variables and mixins need to be imported before other Sass these are added to

Component specific files should be added to that component's directory, e.g. `app/components/my-component/my-component.scss`.

Any _*.scss file in `app/components` (including sub-directories) will be automatically added to the CSS build.
Any `_*.scss` file in `app/components` (including sub-directories) will be automatically added to the CSS build.

0 comments on commit 64898fa

Please sign in to comment.