Humanitarian ID Web App version 2
Building the app
- Clone repo
git clone firstname.lastname@example.org:UN-OCHA/hid_app2.git
- In the app directory
- Switch to the dev branch
git checkout dev
- Install node modules with yarn
- Add the local url to your hosts file:
sudo vi /etc/hosts, then add
- Run the Grunt tasks
grunt. Specify a
--targetto point to different HID API environments
grunt --target=localwill use your local API. Edit
app/config/config.local.jsto configure each endpoint.
Running the app
- visit https://app.hid.vm and accept the SSL certificate exception
This project follows the John Papa Angular 1 style guide. You can lint the codebase by running the following command (look at the ESLint plugin README to interpret the rule names, which link to the styleguide in the format
yarn run lint
The linting is run on every PR via Travis integration. To help keep track of exceptions, the
.eslintrc has explicitly set a few rules to
error to indicate that there are known cases of
eslint-disable-line being used to suppress what would otherwise be an error. If you are able to resolve all violations of a particular rule, you should victoriously remove it from the .
# install Karma CLI yarn global add karma-cli # Run tests once grunt test # Re-run tests when files are changed grunt test-watch
E2E is implemented with Jasmine with the help of Protractor, an end-to-end testing tool for Angular.
Installation on host machine:
# install E2E tools: first-time setup yarn global add protractor webdriver-manager update
Manually install Java Development Kit (JDK)
You will need to add the environment variables to run the tests locally.
- Ask Marina to share 'Test Accounts on FIS Platforms' Trello card with you.
- Manually copy the info from the Trello card into the environment file. This is a one-time setup.
Finally, make sure you're running both containers (API/App) and they're both properly configured for local development.
Now you can run the E2E tests:
# Run all E2E tests in series yarn run protractor # Run a single E2E test suite. Look in conf.js for suite names. protractor --suite="my-suite-name" src/e2e-tests/conf.js
What to do if it fails during local testing
- Your DB might not have the right content, so check the test logs for specific strings that aren't matching (e.g. "Test Admin" vs "Test E2E Admin" or minor differences like that). In general, taking a snapshot of Staging will get you the correct content.
What to do if it fails on TravisCI
The tests are prone to random failures on Travis. If this happens:
- Manually check on staging to see if you can recreate the problem
- If you can, fix your code!
- If you can't, try re-running the tests in Travis and if possible alter the failing test to make it more robust
If the tests fail you may need to log in and reset some things required for the tests manually.
As Test E2E User:
- Unfavourite 'E2e test list - standard'
- Delete 'E2e temp list'
As Test Admin E2E User:
- Delete 'E2e temp mailchimp service' and 'E2e temp google service'
- Delete 'E2e temp' user
- Un-verify 'Test E2E user'
- Cancel pending connection with 'Test E2E user'
This project uses Sass
grunt watch to watch for changes and rebuild the css.
Global styles, such as resets and grid styles, should be added to
_*.scss file in
app/common (excluding sub-directories) will be automatically added to the CSS build.
Variables and mixins
As variables and mixins need to be imported before other Sass these are added to sub-directories in
app/common and manually imported into
Component specific files should be added to that component's directory, e.g.
_*.scss file in
app/components (including sub-directories) will be automatically added to the CSS build.