Giter Site home page Giter Site logo

akintolga / superdesk-planning Goto Github PK

View Code? Open in Web Editor NEW

This project forked from superdesk/superdesk-planning

0.0 2.0 0.0 5.4 MB

Planning feature for Superdesk

JavaScript 44.84% Makefile 0.45% CSS 2.14% HTML 0.22% Python 45.90% Gherkin 6.44%

superdesk-planning's Introduction

Superdesk Planning

Sept 2016, Berlin
Build Status

Overview

This is a plugin for superdesk-client-core and superdesk-core. It adds a planning application page and a new tab in the settings with its API endpoints.

Installation

The superdesk-planning node module is already included in superdesk-core-client. But in order to see the planning feature in the application, you need to enable it.

Client: Enable the superdesk-planning module

In client/superdesk.config.js from superdesk, add this line

features : {planning: true},

This will import the superdesk-planning node module and load the superdesk.planning angular module in the main angular application.

Server: Load the superdesk-planning module

--- a/server/settings.py
+++ b/server/settings.py
@@ -132,7 +131,8 @@ INSTALLED_APPS.extend([
+    'planning',
 ])

Development

Rules

All the code related to the planning feature must be part of this superdesk-planning repository.
How? By using the available superdesk services/providers. For instance, Activities has been used to add a settings page.

Sometime, you may need to add something in the application and that is not possible yet to do by using the existing superdesk services/providers. In this case, a generic service/provider must be created in superdesk-client-core in order to obtain the wanted result.
For instance, as these lines are written, there is no proper way to add an icon in the side navigation bar from this superdesk plugin. The workspace service could have a new method registerExtraSidenavItemTemplateUrl which we could call in our superdesk plugin to add a new icon at the bottom of the navigation bar.
It's important to document these services/providers method, in docs/superdesk.md for the moment, in order to make it easy for the next plugin developers.

Development setup

Download and install

git clone [email protected]:superdesk/superdesk-planning.git
make install

Run the tests

source server/env/bin/activate
make test

Connect the repository to superdesk-client-core

npm link
cd /path/to/superdesk-client-core
npm link superdesk-planning

Connect the repository to superdesk-core

cd /path/to/superdesk-core
source env/bin/activate
pip install -e /path/to/superdesk-planning

superdesk-planning's People

Contributors

vied12 avatar thnkloud9 avatar

Watchers

James Cloos avatar Tolga Akin 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.