https://github.com/collective-soundworks/soundworks

Creative coding framework for distributed applications based on Web technologies.
https://github.com/collective-soundworks/soundworks

Last synced: 2 days ago
JSON representation

Creative coding framework for distributed applications based on Web technologies.

• Host: GitHub
• URL: https://github.com/collective-soundworks/soundworks
• Owner: collective-soundworks
• License: bsd-3-clause
• Created: 2014-12-01T10:51:33.000Z (almost 10 years ago)
• Default Branch: main
• Last Pushed: 2024-05-21T17:36:10.000Z (6 months ago)
• Last Synced: 2024-05-21T18:50:40.621Z (6 months ago)
• Language: JavaScript
• Homepage: http://soundworks.dev
• Size: 20.7 MB
• Stars: 111
• Watchers: 15
• Forks: 6
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# soundworks

[![npm version](https://badge.fury.io/js/@soundworks%2Fcore.svg)](https://badge.fury.io/js/@soundworks%2Fcore)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

![soundworks-logo](./misc/assets/logo-200x200.png)

Open-source creative coding framework for distributed applications based on Web technologies.

Primarily focused on music, **soundworks** aims at supporting rapid development of real-time distributed applications using _JavaScript_. It provides abstractions to hide the complexity of the network and to foster very rapid-prototyping and trial-and-error workflows that are typical in artistic practices.

## Documentation

- Guides and Tutorials: [https://soundworks.dev](https://soundworks.dev)

- API: [https://soundworks.dev/api](https://soundworks.dev/api)

## Getting started

The best and most simple way to start using **soundworks** is to use the `@soundworks/create` wizard. 

```sh

npx @soundworks/create@latest

```

![soundworks-create](./misc/assets/soundworks-create-min.gif)

See [https://soundworks.dev/tutorials/getting-started.html](https://soundworks.dev/tutorials/getting-started.html) for more information on the wizard and how to start using **soundworks**.

## Misc

### TypeScript support

Basic TypeScript support will be proposed in a (hopefully) near future. 

However, for maintenance reasons, we aim at following the TC39 and W3C specifications as close as possible. Therefore, we will wait for the https://github.com/tc39/proposal-type-annotations proposal to reach stage 3 to update the source code in a more integrated manner.

### Manual install

Note that the `@soundworks/core` package is automatically installed when creating an application using the `@soundworks/create` wizard, so most of the time you should not have to install this package manually. See [https://soundworks.dev/guides/getting-started.html](https://soundworks.dev/guides/getting-started.html) for more information on the **soundworks** wizard.

```

npm install @soundworks/core

```

## Share with Us

If you made an application using **soundworks** please let us know here: https://github.com/collective-soundworks/soundworks/discussions/61

## Credits

[https://soundworks.dev/credits.html](https://soundworks.dev/credits.html)

## License

[BSD-3-Clause](./LICENSE)