3.8 KiB
LocalLoop Web Interface
This is the repository for the LocalLoop web interface, for traders and customers to see and submit data to the service.
| Branch | Status |
|---|---|
| Master: |  |
| Development: |  |
Getting Started
To get started with development, you will need an up to date version of node.js, git, and access to either the backend dev server, or a local running copy of the backend server from LocalLoop Server.
For your local node.js, We reccomend using n on *nix and Mac, for Windows take a look at nodist - although other options exist. We reccomend Node.js version 8.0.0+ and npm version 5.3.0+.
To get this repository set up, first clone it and then run the following commands:
npm install -g @angular/cli
npm install
Environments
The app defaults to using the development server. For other options, see
src/environments/environments.ts
Testing
There are two types of test in this codebase, unit tests (using Karma) and E2E tests (using Protractor).
Karma Unit Tests
To run these, you just need to run npm run test - this should work without any further configuration. These run the *.spec.ts files next to the normal source files, and are for basic tests for each function on their own.
These tests are a long-running process, and will automatically run on file changes. Just run the command above, and then check back to the browser window that appears to see any errors as you work!
Protractor E2E Tests
To run these, you will need to run the following:
webdriver-manager update
This will download the correct webdriver for you (we use chromedriver), and any other dependencies it needs. After that, you can run the tests with npm run e2e. Note these run once, and will need to be re-run every time you want to run an e2e test. You will also need to run the
These tests are best run regularly, and should show if any issues have emerged in other parts of the application that you are not aware of, or if some part of the flow through the app has changed sufficiently.
Licences
CoreUI
The interface itself is based off of CoreUI which is MIT Licenced.
For information, see LICENCE.MIT included in this repo.
Old README
This is the old README with some minor tips on getting started, and more reading.
Angular2DevelopmentCLI
This project was generated with Angular CLI version 1.0.0-beta.32.3.
Development server
Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
Code scaffolding
Run ng generate component component-name to generate a new component. You can also use ng generate directive/pipe/service/class/module.
Build
Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the -prod flag for a production build.
Running unit tests
Run ng test to execute the unit tests via Karma.
Running end-to-end tests
Run ng e2e to execute the end-to-end tests via Protractor.
Before running the tests make sure you are serving the app via ng serve.
Further help
To get more help on the Angular CLI use ng help or go check out the Angular CLI README.