yonatan-org / versions-tracker-client

Displaying deployment status of applications

Versions Display

This is the front end application of the versions display application, you can get the server side application here: Versions Manager Api.

Prerequisites:

This service uses:

1. Node.js (Express)

Getting Started:

Manual:
This application is based on the react-create-app framework, fire it up by:

npm start

Loading Initial Data:

The application will make a call to [configurableHost]/api/versions and would expect to receive the following object:

{
  program1: [
    {
      projectName: "Program1",
      status: "init",
      commits: [
        {
          name: "deverloper1",
          commitMessage: "commit message",
          imageUrl: "https://randomuser.me/api/portraits/women/97.jpg",
        },
        {
          name: "developer2",
          commitMessage: "commit message 2",
          imageUrl: "https://randomuser.me/api/portraits/women/7.jpg",
        },
      ],
      versionData: {
        commitId: "sdfsdfsdfsdf-sdfsdfsdf",
        version: "1.24",
        buildTime: "2017-09-29 13:28:39",
        environment: "Production",
      },
    },
    {
      projectName: "Program1",
      status: "complete",
      commits: [
        {
          name: "developer1",
          commitMessage: "commit message",
          imageUrl: "https://randomuser.me/api/portraits/men/94.jpg",
        },
        {
          name: "deverloper2",
          commitMessage: "commit message 2",
          imageUrl: "https://randomuser.me/api/portraits/women/15.jpg",
        },
      ],
      versionData: {
        commitId: "sdfsdfsdfsdf-sdfsdfsdf",
        version: "1.24",
        buildTime: "2017-09-29 13:28:39",
        environment: "Production",
      },
    },
  ],
};

Receiving Updates From Server:

The back end service will update the client using Socket.IO by sending the event : “versionEvent” which can be

socket.on('versionEvent', versionEvent => {
    notifyClients(versionEvent);
})