This project was generated with Angular CLI version 1.1.1.
First, you need to clone the repository on your machine
git clone https://github.com/HotMaps/Hotmaps-toolbox-client.git
Go inside your folder and run the following command:
npm install
If any, solve all your installation problems before going any further
Edit .env configuration to match your needs (if running using Docker/docker-compose) or directly in /src/assets/env.js (if you are not using system environment variables):
- api url
- geoserver url
- wiki url
[In case you need to make further configuration, refer to the constants declared in src/app/shared/data.service.ts.]
ng serve --poll 1000
Navigate to http://localhost:4200/
. The app will automatically reload if you change any of the source files.
Run ng generate component component-name
to generate a new component. You can also use ng generate directive|pipe|service|class|module
.
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.
Run ng test
to execute the unit tests via Karma.
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
.
To get more help on the Angular CLI use ng help
or go check out the Angular CLI README.
- Run
npm install --save-dev @compodoc/[email protected]
to install the version 1.0.3 of Compodoc. - Define a script task for it in your package.json : "scripts": { "compodoc": "./node_modules/.bin/compodoc -p tsconfig.json" }
- Run
npm run compodoc
to generate the documentation files. - Run
./node_modules/.bin/compodoc -s
to serve the generated documentation (default http://localhost:8080/)