mjamry / project-launcher

An Electron + React app used as a projects summary/launcher/dashboard

Project Launcher

Contents

• Why?
• Technologies
• Installation
• Configuration
  • App settings
  • Project configuration
  • Themes

Why?

I'm usually working with multiple projects simultaneously. I used to switch between them on daily basics. This tool should be some kind of aggregator allowing to trace all Jira updates and give a one place to store all links and scripts related witch each project.

Technologies

Installation

This is an electron app, so installation is as simple as downloading and running installer. You can find the latest version Here

Configuration

This app has its main configuration file, along with separate config files for each project. Below you can find detailed description for each config entry.

App settings

{
  "isDevelopment": , <- Boolean. To enable dev tools for the app.
  "jiraUrl": "", <- String. Url to the Jira server from which you want to get updates.
  "jiraToken": "", <- String. Jira Token to identify your user on Jira.
  "jiraRefreshTimeoutInMinutes": , <- Number. Defines how often check Jira for updates.
  "jiraHistoryTimeInMinutes": , <- Number. Defines time range for Jira items fetched on the startup.
  "jiraChangelogFields": [], <- Strings. Defines which fields to show for each jira ticket.
  "theme": { <- Colors in hex code format
    "primaryBackgroundColor": ,
    "primaryColor": ,
    "secondaryBackgroundColor": ,
    "secondaryColor": ,
    "background":,
    "highlightBackgroundColor": ,
    "highlightColor": ,
  }
}

Project settings

{
  "id": , <- String. Project ID displayed on menu. :exclamation: Required.
  "name": , <- String. Project name displayed on the project page. :exclamation: Required.
  "iconUrl": , <- String. Project icon displayed on the menu. :warning: Not yet supported.
  "jiraId": , <- String. Jira ID for project.
  "links":
    [
      {
        "name": , <- String. Displayed name.
        "url": <- String. Url to open in a browser.
      }
    ],
  "scripts":
    [
      {
        "name": , <- String. Displayed name.
        "path": <- String. Path to a local application/script.
      }
    ]
}

Themes

Here you can find some example themes.

Dark green:

  "theme": {
    "primaryBackgroundColor": "#2f3e46",
    "primaryColor": "#cad2c5",
    "secondaryBackgroundColor": "#84a98c",
    "secondaryColor": "#2f3e46",
    "background": "#52796f"
  }

Light brown:

  "theme": {
    "primaryBackgroundColor": "#b08968",
    "primaryColor": "#7f5539",
    "secondaryBackgroundColor": "#e6ccb2",
    "secondaryColor": "#9c6644",
    "background": "#ede0d4"
  }