Skip to content

studiorack/studiorack-core

Repository files navigation

studiorack-core

Test

Common methods package shared across StudioRack CLI, app and website for handling installing DAW VST plugin dependencies.

StudioRack Core

Features

  • admin - Standalone script for running plugin installations with admin privileges
  • api - Helper methods for getting data via web requests
  • config- Reading and writing configuration settings
  • file - Helper methods for manipulating local files
  • plugin - Logic for searching and installing plugins
  • project - Logic for searching and indexing audio projects
  • tool - Utilities and tools for validating plugins
  • utils - Other helper methods and string utilities

Installation

To install the common package, run the command:

npm install @studiorack/core

Import the package using:

import { toolInstall } from '@studiorack/core';

Then use the available methods as normal.

Developer information

StudioRack Core was built using:

  • NodeJS 20.x
  • TypeScript 5.x

Installation

To install, build and run code locally, first install dependencies:

npm install

Usage

Run dev command:

npm run dev

Or to create and run a production build:

npm run build
npm start

Deployment

This package is versioned using git tags:

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

It is published to npm using:

npm publish

Contact

For more information please contact kmturley