Skip to content

Latest commit

 

History

History
123 lines (81 loc) · 5.33 KB

README.md

File metadata and controls

123 lines (81 loc) · 5.33 KB
Raw
logo

hyperse data tracker engine

build stable version GitHub top language Licence Discord Twitter

uml

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 100% 191 / 191
🔵 Statements 100% 191 / 191
🔵 Functions 98.21% 55 / 56
🔵 Branches 93.02% 80 / 86

Prerequisites

Before you begin, make sure you have the following installed:

  • Node.js (recommended version 16.x or higher)
  • npm (comes with Node.js)

Installation

// npm
npm i @hyperse/track

// yarn
yarn add @hyperse/track

Development

Important

The following instructions are for those who want to develop the hyperse related framework or plugins (e.g. if you intend to make a pull request). For instructions on how to build a project using Hyperse, please see the Getting Started guide.

1. Clone project to the local directory

git clone https://github.com/hyperse-io/track.git

2. Install dependencies in the root directory

yarn install

or

npm install

The root directory has a package.json which contains build-related dependencies for tasks including:

  • Building & deploying the docs
  • Project for online presentation
  • Linting, formatting & testing tasks to run on git commit & push

3. Testing

Make sure to thoroughly test your changes before submitting them. This includes running unit tests, integration tests, and any other relevant testing methods to ensure code quality and functionality.

The core and several other packages have unit tests which are can be run all together by running npm run test from the root directory, or individually by running it from the package directory.

Unit tests are co-located with the files which they test, and have the suffix .spec.ts.

4. Improve documentation

Documentation is a critical part of any software project. To improve or update the documentation:

  1. Update Documentation Files: If your changes introduce new features, modify existing functionality, or fix bugs, update the relevant documentation files located in the /website directory.

  2. Build and Preview: Ensure that your documentation builds correctly and looks good by running:

cd website

npm run start
  1. Commit Documentation Changes: Make sure all updates to documentation are committed alongside your code changes.

5. Release Process

To make a release:

  1. Commit the Changes: Push your updated files to your branch.

  2. Create a Pull Request: Open a pull request (PR) with your changes. Make sure to include a clear description of what has been updated and why.

  3. GitHub Actions: Once the PR is merged into the main branch, the release process will be automatically handled by GitHub Actions. This includes tasks such as publishing to npm and updating documentation.

Documentation

You can find the Track documentation on the website.

Check out the Sample Example page for a quick start.

License

See LICENSE