@almedso/apis-admin
v0.3.7
Published
APIS extension for adminstration use cases
Downloads
19
Maintainers
Readme
APIS Administration Module
The administration module is part of the APIS frontend for administration of user, access roles organization and sites
APIS Application
The APIS application uses the following technologies:
- typescript
- angular
- material design
For building and packaging
- webpack
- angular cli
For testing and code quality
- karma/jasmine
- protractor
- tslint
For scaffolding
- angular cli
This module plugs into an APIS administration by Dependency injection of an entry point. and a Route. Could be lazy-loaded.
Run Lint/test/build
Run
$ docker build -t pms-build-front -f Dockerfile.build .
$ docker up --rm -e BUILD_TYPE=prod -v $PWD:/app pms-build-front
creates a image that allows running chrome on a framebuffer (i.e. run tests) starts a container from that image and runs lint, tests and finally produces a package available under dist folder. If the package should be production grade the BUILD_TYPE environment variable should be injected. It should should have the value prod.
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.
If you run npm start
it works as ng server
but there are proxy settings
applied to that redicrect server requests to port 3000.
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 npm build build
to build the library. run npm run publish
to publish the library.
Make sure you did npm login before.
Running unit tests
Run ng test
to execute the unit tests via Karma.
Docker Intergration
There are docker files for different images:
- Dockerfile.build: Describes an image to actually run build steps (jshint, test, build-package)
- Dockerfile.prod: Image that can be used to run the static page via nginx
- It listens on port 80
- exposes /var
Assets
The asset foulder is the place for files that are just plain-copied from source to dist. Assets hold
- internationalization data (if not build in etc)
- icons
- config data about end points, static items (created at build time etc)
License
see LICENSE file