@cpelements/cp-comments

RHElements Comments Element

The Rh-comments element will allow you to drop in a comments block that provides badges, feedback.

There is an openapi spec in the repo defining expectations for the CRUD endpoints.

Configuration is defined via a manifest file, and must define the following properties

{
  'base_endpoint' => '',
  'create_path' => '',
  'read_path' => '',
  'update_path' => '',
  'delete_path' => '',
  'index_path' => ''
}

Compiling

npm install in root npm run live-demo select cp-comments on localhost:8000/elements this should open automatically when running live-demo

Dependencies

Make sure you have Polyserve and Web Component Tester installed.

npm install -g polyserve web-component-tester

Dev

npm start

Test

npm run test

Build

npm run build

Demo

Run npm start and Polyserve will start a server and open your default browser to the demo page of the element.

Code style

Comments (and all RHElements) use Prettier to auto-format JS and JSON. The style rules get applied when you commit a change. If you choose to, you can integrate your editor with Prettier to have the style rules applied on every save.