Skip to content

Latest commit

 

History

History
77 lines (49 loc) · 3.51 KB

README.md

File metadata and controls

77 lines (49 loc) · 3.51 KB
Raw

Svelte Elementary Template

Svelte Elementary Template is a template for building Elementary Audio web apps.

Features include:

  • ⚡ Audio Engine. Elementary + Web Audio core engine.
  • ✨ Starter synth. A simple synth with pan and gain controls.
  • 🎹 MIDI and Keyboard controllers. Play the synth with your computer keyboard or MIDI device.
  • 🎛️ Knobs. webaudio-controls unipolar and bipolar knobs with a custom knob component.
  • 💠 Microtunings. Five equal temperaments. Easy to add more.
  • 🌒 Dark and Light Themes. Built with daisyUI. Includes default dark and light themes.
  • 💻 App publishing with Fission. Publish your app to the web in a few simple steps.

Setup

Install dependencies.

npm install

Develop

Work on the application in local development.

npm run dev

Navigate to localhost:3000 in your web browser.

Build

Export a static build.

npm run build

The build outputs the static site to the build directory.

Customize

Update src/app.html with your title and social preview tags. Replace the social preview image static/preview.png with a preview image for your app.

Themes can be customized in tailwind.config.cjs. Update the dark and light themes with your colors and styles. See the daisyUI themes guide for more information.

Knobs can be customized and replaced with knobs from the WebKnobMan gallery. You may need to adjust the styles and the size of the webaudio-param in src/components/controls/Knob.svelte to match your knob. The default unipolar knob and bipolar knob can be themed in the WebKnobMan editor.

Publish

The built site publishes with the Fission CLI and the Fission GH publish action. Publishing from the command line is configured in fission.yaml, and the GitHub publish action is configured in publish.yml.

To setup publishing with the Fission CLI:

  1. Install the CLI
  2. Run fission setup to make a Fission account
  3. Run npm run build to build the app
  4. Delete fission.yaml
  5. Run fission app register to register a new Fission app (accept the ./build directory suggestion for your build directory)
  6. Run fission app publish to publish your app to the web

After publishing, your app will be available online at the domain assigned by the register command.

To set up the GitHub publish action:

  1. Reigster the app with the CLI
  2. Export your machine key with base64 ~/.config/fission/key/machine_id.ed25519
  3. Add your machine key as a GH Repository secret named FISSION_MACHINE_KEY
  4. Update the publish.yml with the name of your registered app

See the Fission Guide and the publish action README for more details.

License

The source code for this template is available under the Apache 2.0 license. Please consult the Elementary License for additional instructions on using the Elementary SDK.