Sha256: 807e3bedf999b539b670b4f1870e96d7e764316913805c710d2625352de757a1
Contents?: true
Size: 1.44 KB
Versions: 44
Compression:
Stored size: 1.44 KB
Contents
# Decidim::Comments The Comments module adds the ability to include comments to any resource which can be commentable by users. ## Usage The Comments component is exposed as a Rails helper: ```ruby <%= comments_for @commentable %> ``` In order to use the helper in your templates you need to include the comments helpers in your application helper: ```ruby include Decidim::Comments::CommentsHelper ``` Finally, add the comments javascript module like this: ```javascript import "src/decidim/comments/comments"; ``` ## Installation Add this line to your application's Gemfile. ```ruby gem 'decidim-comments' ``` And then execute: ```bash bundle ``` ## How to contribute The technology stack used in this module is the following: For the backend side: - Ruby on Rails - GraphQL For the frontend side: - React - Apollo The frontend code can be found in the folder `app/packs. ### Developing React components You need to execute `npm start` in a separate terminal, in the `decidim` root folder while you are developing this module. When you are finished you can build the project for production like this: `npm run build:prod`. We are checking in the bundle into the repository. #### Run tests You can execute `npm test` to run the javascript test suite or you can run `npm run test:watch` to listen for file changes. ## Contributing See [Decidim](https://github.com/decidim/decidim). ## License See [Decidim](https://github.com/decidim/decidim).
Version data entries
44 entries across 44 versions & 1 rubygems