Plugin for Superdesk Live Blog embed
Copyright: Sourcefabric z.ú.
You will need node.js installed.
Once this is done, run the following commands from the root directory to install the rest of the dependencies:
npm install -g grunt-cli # install grunt npm install -g bower # install bower npm install # install node dependencies bower install # install bower components
After that, you can start the local dev server on port
Documentation can be generated in two ways:
a) With Docco, the most used documentation generator.
Docco doesn't provide an index.html file for docs folder nor a structure for the content.
grunt docco:scripts # for source files grunt docco:test # for test files
b) With Docco Husky, which extends Docco providing an index.html with stats.
Docco Husky is not being maintained. Last commit was done two years ago.
plugin-liveblog-embed-server is running a fork from
nistormihai repo, kept up to date by the owner of the repo.
grunt docco-husky:scripts # for source files grunt docco-husky:test # for test files
Info for contributors
Every commit has to have a meaningful commit message in the form:
[JIRA ref] [JIRA Title] or [Title] <empty line> [Description]
Where JIRA ref is the Issue code eg.
For trivial changes you can ommit JIRA ref or Description or both eg.
Add travis.yml files
Every pull request has to have a meaningful message and if not specified in the commits, a good description of what has been done.
You can test your code before sending a PR via: