This is the mono-repository for the Clippet ecosystem consisting of the various web libraries, example projects and sound fonts. These are all available in the packages listed below.
| Name | Path | Published | Description |
|---|---|---|---|
@clippet/react |
packages/libraries/react | NPM | Library for React |
@clippet/free-sound-font |
packages/fonts/free | NPM | Free sound font for public use |
@clippet/cra |
packages/examples/cra | N/A | Integration in Create React App for example and testing purposes |
@clippet/nextjs |
packages/examples/nextjs | N/A | Integration in NextJS for example and testing purposes |
@clippet/vite |
packages/examples/vite | N/A | Integration in Vite for example and testing purposes |
After cloning the repository execute the following command:
npm run setup
This installs all dependencies in all packages of the mono-repo and performs the initial build to verify whether everything is valid.
To start the compilation of all libraries and sound fonts along with the booting of all the example projects for testing run the following command:
npm run start
Everything is booted up in parallel in the same shell. The example projects are available on the following URLs:
| Name | Path |
|---|---|
| CRA (NOT WORKING YET) | http://localhost:5501/ |
| NextJS | http://localhost:5502/ |
| Vite | http://localhost:5503/ |
To clean the local clone from all dependencies, builds and more run the following:
npm run clean
It is recommended to open a shell in the directory of the package you want to publish and execute the following command to test whether the builds and tests are valid:
npm run publish:dry
When this is all good you can publish the package to NPM using:
npm run publish:npm
- Q2 2023: first sound font consisting between 12 and 16 sounds
- Q2 2023: landing page for package
- Q3 2023: in-depth documentation
- Q3 2023: playground to test sounds with UX patterns
- Q3 2023: release of multiple sound fonts
Clippet is developed and maintained by BMD Studio