Code Monkey home page Code Monkey logo

superdesk-client's Introduction

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.

superdesk-client's People

Contributors

actionless avatar amagdas avatar fritzsf avatar hlmnrmr avatar ioanpocol avatar marwoodandrew avatar mugurrus avatar nidzix avatar nistormihai avatar ozanozbek avatar petrjasek avatar sjunaid avatar tictactatic avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.