https://github.com/buildit/synapse
https://github.com/buildit/synapse
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/buildit/synapse
- Owner: buildit
- Created: 2017-01-04T20:48:12.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-04T20:49:03.000Z (over 7 years ago)
- Last Synced: 2025-03-28T20:17:58.280Z (about 1 month ago)
- Language: JavaScript
- Size: 1.45 MB
- Stars: 1
- Watchers: 9
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Synapse
## Quick Start
```
npm install
npm start
```
This builds the app and runs it on a dev server at [localhost:3000](http://localhost:3000/).
## What is Synapse?
Synapse is a Management Information (MI) dashboard that provides visualizations of metrics pertaining to the development and delivery of software projects. Projects exist within the context of Programs (a related grouping of projects) and Portfolios (a related grouping of Programs). Thus Synapse is able to provide overviews across any particular level or grouping.
[Video demo](https://youtu.be/jXXl9Gezxug)
Synapse provides:
- **Project List** - List of the projects currently being tracked. This allows you to select a particular project for viewing. The *New* button also allows you to add a project to the list.
- **Project Projection** - Typically at the beginning of a project the "How long is this going to take" question is asked. The Projection allows you to project a target completion date by tweaking a set of parameters (Start Date, Target Velocity, Backlog Size, ...). The projection is based on an S-Curve concept that allows for adjusting Velocity to support Ramp Up and Release activities. Dark Matter allows you to set a confidence level on the currently known backlog and plan for the discovery of additional requirements.
- **Project Status** - While operational systems provide a team level view one-dimensional view of a Project, they rarely provide the ability to view all of the dimensions that matter. The Project Status page provides a graphical view of a given project's demand (scope), defects (quality), and effort (cost) over the life of the project. This allows the user to rapidly determine if a project is or is not on track across all those dimensions.
In addition the previously created projection can be overlaid to the project's actuals to determine if the project is meeting forecast expectations.
- **Project Details** - The project details view provides a set of instructions to the system. These instructions tell the Synapse what the operational source systems are for the various dimensions, what type the system is, a how to connect to that system to extract the necessary data. Additionally the user can control what what data is displayed and in what order.
The Demand data specifies the status that a work item might be in, and how to stack it on the graph. Status data that exists in the source system but is not listed will be ignored. Additionally the user can decide to group one or more status together on the graph.
The Defect data specifies the severity that a defect item might be in, and how to stack it on the graph. Severity data that exists in the source system but is not listed will be ignored. Additionally the user can decide to group one or more severities together on the graph.
The Effort data specifies the roles that various people fill while working on the project. Effort role types that exists in the source system but is not listed will be ignored. Additionally the user can decide to group one or more roles together on the graph.
#### Deployments
Synapse is currently deployed only on Buildit's VPN. If you have access to the VPN, visit Synapse at:
Staging Environment: [Synapse Staging](http://synapse.staging.buildit.tools)
Production Environment: [Synapse Production](http://synapse.buildit.tools)
### Journey of the project ([The Journey](TheJourney.md))
### Getting Started (how to run it, build, deploy, test, analysis)
#### Prereqs
Node 6.4 or greater for NPM
#### Set up
Install dependencies with:
```
npm install
```
#### Configuration
Configuration for the site are specified in a series of environment variables. These can be provided
as all environment variables are in the shell, or directly in the command line.
* EOLAS_DOMAIN
* TEST_API
* NODE_ENV
If further variables are required, they need to be added to the `webpack.DefinePlugin` configuration in
the `webpack.config.js` file, as webpack prevents environment variables from being directly accessible.
We can then use the variables defined in the config file in our code, using the defined name.
For example, we can refer to the node environment as `process.env.NODE_ENV`.
The api url should be constructed from the provided environment variables, but does not need to be
constructed manually. There is a config helper that can be imported for this purpose.
```
import config from 'helpers/config';
const apiBaseUrl = config.apiBaseUrl;
```
To create domain dynamic values, the docker-compose.yml.template can be used to set NODE_CONFIG json value with any data that you wish to override or add in a dynamic way.
#### Build
Build and watch for changes:
```
npm start
```
#### Test
##### Unit Test
```
npm run test
```
##### Acceptance Test
You need to first have the Synapse app running and that app needs to be appropriately connected to a valid MI REST API service, such as Eolas. See "Configure for Deployments" below.
```
npm run test:acceptance
```
#### Analysis
Code Analysis:
```
npm run lint
```
#### Version
You need to run the following to version and tag the application. You use 'major' to bump the versions major number, 'minor' to bump the version minor version and 'patch' to bump the version patch number.
```
npm version patch -m "SYNAPSE-XX #comment Some version related comment"
```
#### Deploy
We're using a Jenkins pipeline to deploy to production.
###### How to deploy the app to production
- Go to the Jenkins pipeline for [Synapse production] (http://jenkins.riglet:9000/jenkins/job/synapse-prod-pipeline/)
- Click "Build Now", which is on the left side of the page. This will begin the build process.
- Hover over the middle stage -- "Write docker-compose". You'll be prompted to choose a "tag". This allows you to choose which version of the build to send out into the world. Generally, you should use "latest". Click "Proceed".
- Watch for the build to succeed. If it does, you'll see the solid green dot at Jenkins. If not, check the Console Output on Jenkins and debug!
## User Notes
### Configure for Deployments
To run this app, you need access to the management information REST API (code name Eolas). Configuration of the base URL for the REST API is already handled in the deployment pipeline for staging and production. Running this app in a local development environment assumes the REST API service is running on localhost:6565.
### Coding Standards
Our coding standards are enforced by automated linters. (See the linting scripts in package.json and the "
Analysis" stage in our Jenkins pipeline.) We are using Code Guide's style guides for [HTML](http://codeguide.co/#html) and [CSS](http://codeguide.co/#css).
Our Javascript standards are based on Airbnb's [coding standards](https://github.com/airbnb/javascript) and [linting rules](https://www.npmjs.com/package/eslint-config-airbnb). Our custom rules, which overwrite and extend Airbnb's rules, can be found in `/.eslintrc`.
### How to Contribute
This project is currently an internal Buildit project and is not open to external resources. If you are an internal resource, please contact @digitalrigh to gain access to this project.
### Team
@spotted_dog
[Zac Smith](https://github.com/BillyZac)
@jorgesanchez2387
@digitalrigh
### License
[](http://www.apache.org/licenses/LICENSE-2.0)