Skip to content

OpenAttitude/library

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenAttitude instruments

Copyright (c) Torsten Dreyer (torsten@t3r.de). SPDX-License-Identifier: LGPL-3.0-or-later.

This repository contains @openattitude/core (shared panel utilities, Pinia store, SVG helpers) and all instrument Vue packages consumed by the fgpanel application and related tooling.

Layout

  • packages/core — shared library
  • packages/* — individual instruments (each published as @openattitude/...)

Setup

npm install

postinstall runs npm run build --workspaces so dist/ outputs exist for consumers.

Package builds

npm run build

Instrument testbeds

Each instrument package exposes dev:testbed (Vite). From this repository root:

npm run dev:testbed --workspace=@openattitude/steam-clock-generic

Use the workspace name from that package’s package.json. Ports are fixed per package (see each vite.testbed.config.ts or the fgpanel testbed hub table).

New Git repository

After copying or moving this tree out of the fgpanel repo, publish it as its own remote:

git init
git add .
git commit -m "Initial import: core + instrument packages"
git remote add origin <your-github-url>
git push -u origin main

Consuming from fgpanel

During development, fgpanel expects this repository as a sibling directory named openattitude-instruments, with file: dependencies in its package.json.

To use a Git remote instead, publish these packages to npm (or GitHub Packages) and replace file: entries in fgpanel with semver ranges.

Publishing to npm

Releases use GitHub Actions (.github/workflows/publish-npm.yml) with trusted publishing (OIDC). Each @openattitude/* package on npmjs.com must list that workflow under Package → Settings → Trusted publishing.

If npm publish reports 404 (“could not be found or you do not have permission”) while OIDC is configured, use npm ≥11.6.2 (older 11.5.x often misreports trusted-publishing failures as 404; see npm/cli#9088). The workflow upgrades npm before publishing; for local publishes run npm install -g 'npm@^11.6.2'.

About

Shared components for OpenAttitude panels and displays.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors