Skip to content

1nv1n/review-dashboard

Repository files navigation

review-dashboard

version license-apache-2.0 gitter pr-welcome

circle-ci code-climate Known Vulnerabilities davis-dm


Built With

ElectronJS Bootstrap


Run From Source

git clone https://github.com/InViN/review-dashboard.git
cd review-dashboard
npm install
npm start

Build Executable

git clone https://github.com/InViN/review-dashboard.git
cd review-dashboard
npm install
npm run build

This will create the following executable containing directories:

  • ReviewDashboard-win32-x64
  • ReviewDashboard-linux-x64
  • ReviewDashboard-darwin-x64

Download (BETA)


Usage

Initial launch & Server Entry
  • Launch ReviewDashboard.exe & input the full server address for your Crucible instance (eg: crucible.server.com).
    • Toggle between http & https as needed.
    • Use the `+` button to add multiple server instances & hit `Save` once done to bring up the login screen.
Login
  • Input your username & password on the login screen.
Use the button bar (below the App logo), to go through the views of the App.
Create button brings up a dialog to create a new Review.
Search brings up a dialog to search for Reviews by JIRA identifiers (if properly linked).
Pending updates the App with a table of pending reviews (reviews that you need to complete).
Open updates the App with a table of open reviews (reviews that you have created & are currently open).
Statistics updates the App with review statistics.

Features

  • (In progress) Graph Review Statistics
  • Display Open Reviews
  • Display Pending Reviews
  • Create Review
  • Close Open Review
  • Open Review Remind Reviewers
  • Complete Pending Review
  • Add Change Sets to Review
  • Review Reminders (Tray Notification)
  • Diff. Change Sets
  • Add Toast Notifications
  • Add Themes
  • Multi Server Authentication
  • Electron Forge Integration

Other To-Dos

  • Responsive Design
  • Update electronPackagerConfig
  • Update installer config. with loading GIF & icon.
  • Update config. for Linux & Mac installer.
  • Vanilla JS -> Angular 6
  • End-to-End Tests