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. This repo supports the CBoard front-end, providing backend functionality and persistence.
Learn more about the Cboard project.
Before installing and running the Cboard API, be sure you have locally installed the following tools:
Install Swagger globally using npm:
npm install -g swagger
If needed, check out the Swagger docs here.
Use the following commands to check that you have them successfully installed, and/or to double-check your versions:
node -vmongo --versionswagger --version
Clone the repository and install npm dependencies:
$ git clone https://github.com/cboard-org/cboard-api.git
$ cd cboard-api
$ npm installStart MongoDB. (See MongoDB docs, if needed).
$ mongodIn a separate terminal tab/window, run the Swagger project server.
$ swagger project startThis will start a server process listening on port 10010. You will now be able to make calls to the API.
(If you are having trouble, make sure you have successfully installed the pre-requisites -- see "Pre-requisites" section above.)
Swagger provides an interactive, browser-based editor. To visualize available API endpoints, start the editor:
$ swagger project editThat should open a browser window and show API swagger editor (as shown below):
When a new user is created using the API, some verification emails are generated. To use a specific SMPT server, locally edit the following file to use values for an SMTP server you own: config/env/development.js And look for following config block:
emailTransport: {
from: '[email protected]',
host: 'smtp.sendgrid.net',
port: 465,
secure: true,
service: 'Sendgrid',
auth: {
user: 'apikey',
pass: process.env.SENDGRID_API_KEY
}
}