Skip to content

openorg-software/openrqm-client-desktop-nwjs

Repository files navigation

OpenRQM Desktop Client

This OpenRQM Desktop Client is a NW.js project using angular-cli.

Build Status FOSSA Status Quality Gate Status

Content

Hints for reading the OpenRQM Client documentation

The documents can be read best using Visual Studio Code or Atom using the Markdown Preview Enhanced extension since all drawings are created using PlantUML.

How to run / build

This project was generated with Angular CLI version 8.3.5.

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.

Then the nw-package.json has to be copied to the dist/openrqm-client-desktop-nwjs/ directory.

Afterwards running <Path to nw.js>\nw.exe dist/openrqm-client-desktop-nwjs/. on Windows or <Path to nw>/nw dist/openrqm-client-desktop-nwjs/. on Linux can be used to run the application.

To package the software for release please follow the guildelines of nw.js.

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.

Design & Architecture

The design and architecture is described in the documents in the doc directory.

Features

Feature Status Release
Basic workspace explorer & document viewer done MVP
User management done MVP
Linking done MVP
PDF export done MVP
Multiple views per document
Baselining
Shared edit
Multimedia content (figures, tables) done
Tracing Graphs

License

SPDX-License-Identifier: GPL-2.0-only

FOSSA Status

Copyright

Copyright (C) 2019 - 2020 Benjamin Schilling