Skip to content

open-audio-stack/open-audio-stack-site

Repository files navigation

Open Audio Stack Logo
Open Audio Stack

Audio registry specification and API with searchable list of packages

Registry Specification ⦁︎ Registry API ⦁︎ Roadmap ⦁︎ View all added plugins here

Test Release Join the chat at Discord

Open Audio Stack - Registry - Specification 1.0.0

open-audio-stack-site

Website for Open Audio Stack with tools to create Plugin, Preset and Project packages.

Who is this for

This website is built for audio software developers who want to register their software with Open Audio Stack. It provides a guided GUI for authoring package metadata — filling out fields, generating yaml, and submitting it to the registry via GitHub — so developers don't have to hand-write the format from scratch.

It is part of a wider effort to make audio software distribution an open, interoperable standard: developers register their plugins, presets, projects and apps once, and any compatible tool can discover and install them. The ultimate beneficiaries are audio software developers' own customers — musicians and music producers — who get a more consistent experience installing audio software.

  • Primary audience: audio software developers authoring and submitting packages.
  • Secondary audience: musicians and music producers who install and use those packages.

For the wider project context and strategy, see Open Audio Stack.

Developer information

Open Audio Stack Registry was built using:

  • NodeJS 20.x
  • TypeScript 5.x
  • eslint 9.x
  • prettier 3.x
  • vitest 1.x

Developer installation

Install dependencies using:

npm install

Developer usage

Run dev commands using:

npm run lint
npm run format
npm run dev
npm test

Create a production build using:

npm run build

Run the production build:

npm start

Developer deployment

This package is versioned using git tags:

npm version patch
git push && git push origin --tags

GitHub Actions will automatically publish the site to Github pages at:

https://open-audio-stack.github.io/open-audio-stack-site

Contact

For more information please contact kmturley

About

Website for Open Audio Stack with tools to create Plugin, Preset and Project packages.

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages