https://github.com/chroma-sdk/chroma-js

JavaScript client for the Razer Chroma REST API
https://github.com/chroma-sdk/chroma-js

Last synced: 3 months ago
JSON representation

JavaScript client for the Razer Chroma REST API

• Host: GitHub
• URL: https://github.com/chroma-sdk/chroma-js
• Owner: chroma-sdk
• License: mit
• Created: 2017-04-03T10:52:25.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-05-09T00:19:08.000Z (over 6 years ago)
• Last Synced: 2024-07-30T05:33:19.679Z (3 months ago)
• Language: TypeScript
• Homepage:
• Size: 25.4 KB
• Stars: 24
• Watchers: 4
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-chroma - Chroma JS - JS client for the Razer Chroma REST API (SDK Libraries / Official Integrations)

README

        
# Chroma.js

[![CircleCI](https://circleci.com/gh/chroma-sdk/chroma-js.svg?style=svg&circle-token=d066d70fae54ca26b07aad36250e78d478c62790)](https://circleci.com/gh/chroma-sdk/chroma-js)

Chroma.js is a library that provides a simple interface to interact with Razer's Chroma REST API.

## Building from source

After cloning this repository the Typescript Code needs to be transpiled.

This is done either by using your IDE (VS-Code is configured) or by going into the "sdk" directory and running:

```node

npm install

npm run build

```

or

```node

yarn install

yarn run build

```

Now the `dist` folder contains all the needed files.

Afterwards you can start the example by executing the following in the example folder:

```node

npm install

npm run dev

```

or

```node

yarn install

yarn run dev

```

This will start a Javascript development Server running on `http://localhost:8080`

To run the Node.js version just do in the example directory:

```node

yarn install

yarn run build

node dist/Server.bundle.js

```