open-index/open-npm huggingface dataset:
npm package: @soundworks/build
Description: Build tools for soundworks applications
Latest version: 5.2.5

# soundworks | build

Build tools for [`soundworks`](https://soundworks.dev) applications.

The build tools are mainly wrappers around:
- [swc](https://swc.rs/)
- [rolldown](https://rolldown.rs/)

## Install

Note that the `@soundworks/build` package is automatically installed when creating an application using the `@soundworks/create` wizard and heavily rely on the file structure defined in the generated template, so most of the time you should not 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 --save @soundworks/build
```

## Usage

As for the installation, the commands provided by `@soundworks/build` are used by npm scripts in applications created using the `@soundworks/create` wizard, so most of the time you should have to use these commands directly.

Refer to the `README.md` file of your application to see the available npm commands.

```
Usage: soundworks-build [options]

Options:
  -b, --build                 build application
  -w, --watch                 watch file system to rebuild application, use in conjunction with --build flag
  -p, --watch-process <name>  restart a node process when its sources
  -i, --inspect               watch process with --inspect flag, use in conjunction with --watch-process flag
  -D, --delete-build          delete build directory
  -h, --help                  display help for command
```

## Notes

### Extending configuration

### Dynamic imports

### Typescript support

## License

[BSD-3-Clause](./LICENSE)
npm package: @soundworks/core
Description: Open-source creative coding framework for distributed applications based on Web technologies
Latest version: 5.4.3

# 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)
npm package: @soundworks/create
Description: Interactive command line tools to create and manage soundworks applications.
Latest version: 6.0.1

# soundworks | create

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

Interactive command line tools to create and manage [soundworks](https://soundworks.dev) applications.

_Tutorial_: [https://soundworks.dev/tutorials/getting-started.html](https://soundworks.dev/tutorials/getting-started.html)

## Usage

### Application generator

```sh
npx @soundworks/create@latest [app_name]
```

### Wizard in existing applications

```sh
npx soundworks
```

## Available Commands

```
Usage: wizard [options]

Options:
  -c, --create-client    create a new soundworks client
  -p, --install-plugins  install / uninstall soundworks plugins
  -l, --install-libs     install / uninstall related libs
  -f, --find-doc         find documentation about plugins and related libs
  -i, --config-infos     get config information about you application
  -C, --create-env       create a new environment config file
  -b, --extend-build     extend the build settings (babel, webpack) of your project
  -e, --eject-launcher   eject the launcher and default views from `@soundworks/helpers`
  -d, --check-deps       check and update your dependencies
  -h, --help             display help for command
```

## Notes

### Development notes

To develop the application generator locally:

```sh
// link globally in `soundworks-create` directory:
sudo npm link
// create an app with --debug flag
npx @soundworks/create --debug
// later, unlink globally
sudo npm unlink --global @soundworks/create
npm ls --global
```

### Todos

- [ ] typescript template
- [ ] new client templates (connection screen, etc.)

## Credits

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

## License

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