Web Audio Components Service
============

[![Build Status](https://travis-ci.org/web-audio-components/web-audio-components-service.png)](https://travis-ci.org/web-audio-components/web-audio-components-service)

The API supporting the Web Audio Components project.

Currently hosted at [web-audio-components-api.jit.su](http://web-audio-components-api.jit.su)

## API

`GET /components`

Returns an array of all audio components

`GET /components?q=query`

Returns an array of components that match query

`GET /components/:owner/:repo`

Returns the component that matches the owner/repo name

`GET /components/:owner/:repo/script.js`

Returns the corresponding component's script

`GET /components/:owner/:repo/build.js`

Returns the corresponding component's built script

## Todo

* Add mock component that requires dependencies
* Twitter posts on new package, like component(1)
* Remove components that are no longer in the registry from the DB

Web Audio Components Service
============

[![Build Status](https://travis-ci.org/web-audio-components/web-audio-components-service.png)](https://travis-ci.org/web-audio-components/web-audio-components-service)

The API supporting the Web Audio Components project.

Currently hosted at [web-audio-components-api.jit.su](http://web-audio-components-api.jit.su)

## API

`GET /components`

Returns an array of all audio components

`GET /components?q=query`

Returns an array of components that match query

`GET /components/:user/:project`

Returns the component that matches the user/project name

`GET /components/:user/:project/script.js`

Returns the corresponding component's script

`GET /components/:user/:project/build.js`

Returns the corresponding component's built script

## Development

Install dependencies via `npm install` and run mongodb via `mongod`. Start up the server with `node .`, and go to `localhost:8000` to view the service. By default, the development environment uses mock data, but can be changed to use the components service by changing `USE_MOCKS` to true in the config.

Run tests with `npm test`.

Add development information, remove todo in lieu of issues
Add development information, remove todo in lieu of issues
