README

Pulsar is the User Experience and Interface framework for Jadu software.

Introduction

Watch a Jadu Academy session presented by Paul Stanton, Pulsar Product Owner which gives an overview of Pulsar and how it influences our product development.

Documentation

Documentation is available online at https://jadu.github.io/pulsar, we welcome any feedback on areas which may need improvement.

Installation

Using Docker Compose

Prerequisites

• Docker Desktop (version 4.0.0+) - includes Docker Engine and Docker Compose
• Git (version 2.0.0+)

Steps

1. Clone the repository:

   git clone https://github.com/jadu/pulsar.git
   cd pulsar

2. Start the Docker containers:

   docker compose up -d

3. Access Pulsar: Once the containers are running, Pulsar should be available at http://localhost:9000

4. Stop the containers when finished:

   docker compose down

Contributing

New issues can be submitted through the GitHub Issue Tracker, and Pull Requests are very welcome, please take a minute to read our notes for contributors.

Mission Statement

• Improve code quality and consistency
• Enable developers to prototype in hours, not days
• Allow the continual release of UI improvements
• Provide a common UI language to help new developers learn our lingo
• Provide a starting point to redesign older parts of the software
• Improve performance
• Make our interfaces more testable
• Make the users of our software happier
• Make the people designing Jadu interfaces happier
• Learn how our customers use our software
• Learn what our customers need (not necessarily what they ask for) so that we can build the right thing
• Reduce the complexity of the tasks our customers need to perform
• Define clear, understandable guidelines for developers to build awesome things

License

MIT © Jadu