Skip to content

petalslink/petals-cockpit-old

Repository files navigation

Warning This project is discontinued, the current ongoing development repository of Petals Cockpit is located here: https://gitlab.com/linagora/petals-cockpit

Petals COCKPIT

  • This is a web application prototype to drive Petals ESB servers.
  • This app provides a starter project that implements best practices in coding, building and testing AngularJS applications using Material design.

Technologies

Frontend

  • A well-organized component hierarchy starting from approot. Components are implemented using directives (no dangling controllers). This provides a good architectural direction until Angular 2.0 becomes available.
  • Follows AngularJS Style Guide.
  • Uses AngularUI Router for flexible routing and nested views.
  • Uses Angular Material to implement an interface that conforms to Material design.
  • Provides logging and exception handling frameworks with toaster notifications.
  • Provides a Gulp based build system – code changes are reflected in the browser immediately.
  • Uses Karma, Mocha and Chai for testing.

Backend

Requirements

WebStorm was used to develop it, but any IDE should work. Everything you need is to...

  1. Install Git

  2. Install MongoDB

  3. Install Java 8 and Maven

Quick Start

Clone this repo

$ git clone https://github.com/petalslink/petals-cockpit.git

Open a terminal in your project's directory.

$ cd petals-cockpit
$ npm install
  • npm install will install the required node libraries under node_modules and then call bower install which will install the required client-side libraries under bower_components.

Running your Application

Once the install process is over, you will be able to run your application with Gulp. Run Gulp's default task.

$ gulp serve-dev

Petals cockpit starts and displays an authentication page in your browser :

Authentication Popup

By default , we use 'admin', 'admin' to authenticate.

Running only the backend

During tests, it can be needed to only run the backend (mongod and the API server):

$ gulp serve-mongod serve-java

Populating the database with demo data

A dataset is available for testing, it is easy to populate the database suing:

$ gulp serve-mongod populate-demo