Locations sample client (Angular)

Summary

This is a sample client for locations service written in Angular.

!important: before running this client you have to add this line to the styles array in your angular.json file to load leaflet(map library used by this client) global styles like this:

"midgard-angular": {
            ...
            "styles": [
              "src/styles.scss",
              "./src/clients/locations/node_modules/leaflet/dist/leaflet.css"
            ],
            ...

Dependencies

npm libraries

List of npm packages used
List of npm packages used

Develop this client

To build the project: ng build {name-of-module}
The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.
To run tests using Karma: ng test {name-of-module}
To run end-to-end tests using Protractor: ng e2e {name-of-module}

File structure

/components: Components that do not have roots assigned to them.
/helpers: The client's helper classes.
/pages: Components that have roots assigned to them.
/services: Classes that provide data.
/state: State-related files and data models.
/styles: Contains styles specific to the client.
routing.module.ts: Where the client's routes are defined.
ngModule: Where components, services, pipes, etc. are defined.

Services

This client connects to the following services:

Document the ways in which this client connects to the service. Methods used, data models used, endpoints used, etc.

API documentation (Compodoc)

Run npm run compodoc to generate Compodoc documentation to the /documentation directory.

License

This code is released under the Humanitec Affero GPL.

Arlus/locations_client_angular