Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 1.62 KB

README.md

File metadata and controls

53 lines (41 loc) · 1.62 KB
Raw

soundworks-template

Project template for developing soundworks applications.

For a complete documentation of soundworks, please refer to http://collective-soundworks.github.io/soundworks/

Creating a new application

To start the development of a new soundworks application, we recommend the following sequence of commands:

git clone https://github.com/collective-soundworks/soundworks-template.git my-soundworks-application
cd my-soundworks-application
rm -Rf .git
npm install
# to start development
npm run watch

Commands

# build es-next sources to node and browser compliant files
npm run build
# starts the server and watches the file system re-build application
npm run watch
# re-build and creates minified version of browser clients
npm run minify
# starts the server
npm run start

Files structure

The template consists of the following files and directories:

  • config - config files written using JSON5
    • application.json - application config file
    • env - folder
  • public - public directory, accessible through http
  • src - javascript sources
    • clients - sources of every clients (browser or node),
      each folder should be dedicated to a specific client, for example:
      • player
      • controller
      • ...
    • server - sources of the server
    • config - environnement config files

@important - this structure is required by the helper scripts, modify at your own risks.

License

BSD-3-Clause