Skip to content

liveblog/superdesk-client

 
 

Repository files navigation

Superdesk Client

Build Status devDependency Status Coverage Status

Superdesk Client is a javascript client for Superdesk REST API server.

License: GPLv3

Copyright: Sourcefabric o.p.s.

Setup

There are few different ways to run it:

a) locally

Client requires nodejs installed and a few steps:

npm install -g bower grunt-cli
npm install # install other node dependencies
bower install # install bower components

After you can start local dev server on port 9000:

grunt server

b) using Docker

This command will start frontend on localhost:9000. Change http://localhost:5000 to an actual backend server:

docker build -t superdesk-client:devel ./
docker run -i -p 9000:9000 -t superdesk-client:devel grunt server --server=http://localhost:5000 --force

c) using Vagrant

Will start frontend on localhost:9000:

vagrant up --provider=docker

Info for contributors

Commit messages

Every commit has to have a meaningful commit message in form:

Title
[<empty line>
Description]
[<empty line>
JIRA ref]

Where JIRA ref is at least Issue code eg. SDUX-13.

For trivial changes you can ommit JIRA ref or Description or both: Fix typo in superdesk.translate docs.

CI

You can test your code before sending a PR via: grunt ci

UI Components Documentation

While running dev server, you can access documentation page on localhost:9000/docs.html.

Running documentation separately is possible through: grunt docs.

Packages

No packages published

Languages

  • JavaScript 63.8%
  • CSS 36.1%
  • Shell 0.1%