Cboard API - REST API for CBoard application

Cboard is an augmentative and alternative communication (AAC) web application, allowing users with speech and language impairments (autism, cerebral palsy) to communicate by symbols and text-to-speech.

The app uses the browser's Speech Synthesis API to generate speech when a symbol is clicked, there are 3400 symbols to choose from when creating a board. Cboard is available in 33 languages (support varies by platform - Android, iOS, Windows).

We're using Discord to collaborate, join us at: https://discord.gg/TEH8uxh

How does it work?

This video from Real Look Autism will help you understand how communication boards are being used.

Disclaimer: the app in the video is not Cboard.

Quick start

Install

Clone repository and install npm dependencies:

$ git clone https://github.com/cboard-org/cboard-api.git
$ cd cboard-api
$ npm install

Run the API Server

Using swagger for nodejs. You need to install swagger for node locally first, Install it using npm. For complete instructions, see the install page.

$ npm install -g swagger
$ swagger project start

That should start a server process listening on port 10010.

See API Paths

By using swagger edit appication:

$ swagger project edit

That should open a browser window and show API swagger editor like below:

License

Code - GPLv3
Symbols - CC BY-SA

ktamir/cboard-api