Documentation

OpenHPS
OpenHPS Web Components

Build Status Maintainability npm version

@openhps/coreAPI


This is a monorepo for all web components of OpenHPS.

Installation

yarn workspaces run build

Commit

Linting

Make sure to run yarn run lint -- --fix to fix and detect any linting issues. Ensure there are no errors or warnings.

Testing

Test any changes using yarn run test which will perform unit tests on existing features. Contributors are expected to create unit tests for new features.

Contributors

The framework is open source and is mainly developed by PhD Student Maxim Van de Wynckel as part of his research towards Hybrid Positioning and Implicit Human-Computer Interaction under the supervision of Prof. Dr. Beat Signer.

Contributing

Use of OpenHPS, contributions and feedback is highly appreciated. Please read our contributing guidelines for more information.

License

Copyright (C) 2019-2023 Maxim Van de Wynckel & Vrije Universiteit Brussel

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.