# musiquejs

> Musique.js

Latest version **1.3.0** (published 2024-07-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install musiquejs
pnpm add musiquejs
yarn add musiquejs
bun add musiquejs
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.0 |
| Published | 2024-07-23 |
| First published | 2023-11-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 47.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | alusinviii, nispeon, bakabruh, lainocs |

## Links

- npm: https://www.npmjs.com/package/musiquejs
- npm.io page: https://npm.io/package/musiquejs

## Recent versions

- 1.3.0 (latest) — 2024-07-23
- 1.2.0 — 2024-04-19
- 1.1.0 — 2024-03-17
- 1.0.0 — 2023-12-18
- 0.3.0 — 2023-12-12
- 0.2.2 — 2023-12-05
- 0.2.1 — 2023-11-27
- 0.2.0 — 2023-11-17

## README

<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>

<p align="center">
  <a aria-label="NPM version" href="https://www.npmjs.com/package/musiquejs">
    <img alt="Static Badge" src="https://img.shields.io/badge/v1.2.0-grey?logo=npm&label=Musique.js&labelColor=%23f13964&color=%23f13964">
  </a>
  <a aria-label="License" href="https://github.com/musiqueJS/musiqueJS/blob/main/LICENSE">
    <img alt="Static Badge" src="https://img.shields.io/badge/MIT-grey?label=License&labelColor=%23c429e2&color=%23c429e2">
  </a>
  <a aria-label="Built with love" href="https://github.com/musiqueJS/musiqueJS/graphs/contributors">
    <img alt="Static Badge" src="https://img.shields.io/badge/%E2%9D%A4-grey?label=Built%20with&labelColor=%238206f9&color=%238206f9&link=https%3A%2F%2Fwww.musiquejs.com%2F">
  </a>
</p>

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/](https://www.musiquejs.com/) to see what we're about!

You can also find us on [𝕏](https://twitter.com/MusiqueJS)
## Documentation

The full documentation can be found at [https://docs.musiquejs.com/](https://docs.musiquejs.com/).

## How to use

Here is a small snippet to show you how easy it is to create musique:

```js
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](https://nodejs.org/en) (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](https://github.com/musiqueJS/musiqueJS/labels/good%20first%20issue) will be receive the appropriate tags.

## Authors

- Tom Louveau ([@bakabruh](https://github.com/bakabruh))
- Nicolas de Garrigues (𝕏 [@nicodegarrigues](https://twitter.com/nicodegarrigues))
- Julien Cousin-Alliot (𝕏 [@nispeon](https://twitter.com/nispeon))
- Malo Braunschweig (𝕏 [@alusinviii](https://twitter.com/alusinviii))

---
_Source: https://npm.io/package/musiquejs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._