Public Repository

Last pushed: 5 days ago
Short Description
The angular frontend for the HipCmsApi
Full Description

HiPCMS Angular4 App

HiP-CmsAngularApp is a content management system which is developed by the project group History in
Paderborn
.
It is developed to fill the system 'History in Paderborn' with data. This is only a client application.

We also develop a REST API which provides service end points. The REST API is built on .NET Core 1.1.

In another team of the project group, mobile apps are developed that will
make the content of HiPCMS accessable to the public.

See the LICENSE file for licensing information.

See the graphs page
for a list of code contributions.

Requirements:

  • Node version >= 6.9 and NPM >= 3

Technolgies and Frameworks

HiP-CmsAngularApp is a client application built on Angular 4.0.

Getting started

  • Clone the repository.
  • Navigate to cd HiP-CmsAngularApp
  • npm install to install all dependencies
  • create a hip-config.json config file, like hip-config.json.example with correct urls
  • npm start compiles the application, then simultaneously re-compiles and runs the lite-server

To get an optimized version for deployment run the following commands before npm start:

  • npm run build_prod bundles all project *.ts files to a dist/bundle.min.js file which can be served to the client.
  • prepare_public.sh copies dist/bundle.min.js into the root folder and adjusts the index.html the minimized bundle.
  • cleanup_publish.sh deletes all the files not needed for a deployed version.

How to develop

How to maintain coding standards

After completing development it is recommended to execute npm run lint command which will give all the coding standard issues. Fix the issues and then give a pull request.

How to test

  • Clone the repository.
  • Navigate to cd HiP-CmsAngularApp.
  • npm install to install all dependencies.
  • npm test runs the unit Tests for testing Angular 4 code with Jasmine and Karma.
  • npm run e2e runs the End to End tests using Protractor.

If you test on the optimized version, you have to run the tests before cleanup_publish.sh.

How to build and run as a Docker Container

  • npm run docker

How to submit Defects and Feature Proposals

Please write an email to hip-app@campus.upb.de.

Source Code Documentation

You can create a source documentation by running: npm run doc.
The created documentation takes place in docs/.

Contact

HiP (History in Paderborn) ist eine Plattform der:
Universität Paderborn
Warburger Str. 100
33098 Paderborn
http://www.uni-paderborn.de
Tel.: +49 5251 60-0

You can also write an email.

Docker Pull Command
Owner
hipcms

Comments (0)