Skip to content

innovation-hub-bergisches-rheinland/prox-web-client

Repository files navigation

Prox Web Client

This web application acts as the frontend to Prox.

This project was generated with Angular CLI version 7.2.3.

Installation

To use the services from *.archi-lab.io

# Execute from the project root folder
docker build -t docker.nexus.archi-lab.io/archilab/prox-web-client -f ./docker/Dockerfile .

To use the local/dev services from localhost

# Execute from the project root folder
docker build --build-arg APP_ENV="" -t docker.nexus.archi-lab.io/archilab/prox-web-client -f ./docker/Dockerfile .

Builds a Docker image based on the source code and the dependencies in the package.json and package-lock.json.

Local usage

Powershell

$env:IMAGE='prox-web-client'; `
$env:TAG='latest'; `
docker-compose -f ./docker/docker-compose.yml up

Bash/Shell

export IMAGE="prox-web-client" &&
export TAG="latest" &&
docker-compose -f ./docker/docker-compose.yml up

Starts a Docker container based on the compose file and the image. A Docker network named prox is required for the communication between services:

docker network create prox

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|guard|interface|enum|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.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

Development

Please consider our contributing guidelines.

Commit Messages

The commit messages SHOULD adhere to the Conventional Commits specification. This repository is also Commitizen-friendly. You can use Commitizen seamless in this repository.

Perform a release

In general releases are done by pushing a git tag which conforms to SemVer specification. We prefix those tags with a v, so the tag itself MUST follow the pattern vMAJOR.MINOR.PATCH. A label is not used.

The simplest way to perform a release is by relying on our standard-version configuration. If you are ready to perform a release simply call

$ npx standard-version
# or
$ npm run release

This will analyze the last commits since the last release, determine the new version, generate a changelog and create a git tag for you. Next up you will need to push the tag and version bumped files, our release pipeline will take care of the rest.

$ git push --follow-tags origin main

About the Team

This service is currently developed by members of the ArchiLab staff: