musiquejs
v1.2.0
Published
<p align="center"> <a href="https://musiquejs.com"> <img src="https://github.com/musiqueJS/musiqueJS/assets/37938250/ac05bb96-dfc5-4d8a-8040-3abea30fa761" height="128"> <h1 align="center">Musique.js</h1> </a> </p>
Downloads
74
Readme
Musique.js is a small JS library which aims to help developers easily create melodies for their websites, with pretty much no prior musical knowledge!
We have a website!
Visit https://www.musiquejs.com/ to see what we're about!
You can also find us on 𝕏
Documentation
The full documentation can be found at https://docs.musiquejs.com/.
How to use
Here is a small snippet to show you how easy it is to create musique:
import { Partition, Note } from 'musiquejs';
const partition = new Partition(
[
new Note('D', 4, 0.18),
new Note('D', 4, 0.18),
new Note('D', 5, 0.36),
new Note('A', 4, 0.54),
],
'sine',
new AudioContext()
);
partition.play();
Installing the project
Dependencies
To install the project locally if you want to contribute (thanks!), you will need:
- Node (we recommend >= v19, but there's no hard limit)
- … That's it!
Running the project
To test your changes to the package locally, you will have to:
- Build the project (
pnpm build
); - Create another project/directory on your machine;
- In there, use
npm link musiquejs
to import the local version of the package; - Use your modified version! (if you change the code, you will need to repeat step 1, the link however is only a one-time command)
- Don't forget about the linting with
npm run lint
Contributing
Contributing is more than encouraged, no matter how!
Opening Pull Requests is great, but opening issues to point out issues already goes a long way!
Good First Issues
Every issue we identify as good first issues will be receive the appropriate tags.
Authors
- Tom Louveau (@bakabruh)
- Nicolas de Garrigues (𝕏 @nicodegarrigues)
- Julien Cousin-Alliot (𝕏 @nispeon)