Merge pull request #309 from oslabs-beta/dev

Chronos V12

Author: eishakaushal

.github/workflows/integrate.yml

@@ -0,0 +1,31 @@
+name: Frontend and Backend testing
+
+on:
+  pull_request:
+    branches: [master]
+##Branch name may need to be changed depending on name of your dev branch
+jobs:
+  frontend_testing:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 18
+      - run: npm install --package-lock-only
+      - run: npm ci
+      - run: npm run build
+      - run: npm run test
+
+  backend_testing:
+    runs-on: ubuntu-latest
+    timeout-minutes: 7
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 18
+      - run: npm install --package-lock-only
+      - run: npm ci
+      - run: npm run build
+      - run: npx jest --config __backend-tests__/jest.config.js --verbose

.github/workflows/publish.yml

@@ -0,0 +1,19 @@
+name: Publish Package to npmjs
+on:
+  release:
+    types: [published]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '18.17.1'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm publish ./chronos_npm_package --access=public
+        env:
+          # need to add NPM token to github secret if not available
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.prettierrc

@@ -4,4 +4,4 @@
   "endOfLine": "auto",
   "arrowParens": "avoid",
   "printWidth": 100
-}
+}

README.md

@@ -2,12 +2,10 @@
     <img src="assets/animated_logo.gif" alt="Chronos" title="Chronos" align="center" height="500" />
 </a>
 
-<br>
-
 ![Build Passing](https://img.shields.io/badge/build-awesome-brightgreen)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/open-source-labs/Chronos)
 ![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)
-![Release: 11.0](https://img.shields.io/badge/Release-11.0-brightgreen)
+![Release: 12.0](https://img.shields.io/badge/Release-12.0-brightgreen)
 
 
 # Chronos
@@ -16,27 +14,36 @@
 ### ⭐️ Star us on GitHub! ⭐️
 **Visit our website at [chronoslany.com](https://chronoslany.com/).**
 
-Chronos is a comprehensive developer tool that monitors the health and web traffic of servers, microservices, containers, and Amazon Web Services (AWS). Use Chronos to see real-time data monitoring and receive automated notifications over Slack or email.
+Chronos is a comprehensive developer tool that monitors the health and web traffic for containerized (Docker & Kubernetes) and non-containerized microservices communicated via REST APIs or gRPC, whether hosted locally or on Amazon Web Services (AWS). Use Chronos to see real-time data monitoring and receive automated notifications over Slack or email.
 
 
 ## What's New?
 
-### With Chronos 11.0:
+### With Chronos 12.0:
+
+- Enhanced metrics visualization by integrating more interactive and adaptable Grafana charts for Docker and Kubernetes use cases.
+- Achieved an 80% boost in test coverage by formulating comprehensive unit, integration, and end-to-end tests employing Jest and Selenium.
+- Implemented Prometheus data scraping functionality for Docker containers, facilitating seamless metric collection and monitoring.
+- Devised an immersive 3D visualization that effectively illustrates the Kubernetes cluster infrastructure, encompassing Namespace, Service, and Pod entities. This dynamic visualization provides developers and users with heightened insights into intricate resource allocation and configuration within the cluster.
+- Streamlined operational effectiveness by coordinating CI/CD pipelines, automating testing workflows, and establishing deployment protocols, ultimately leading to accelerated development cycles and heightened dependability.
+- Expanded Typescript coverage to enhance code quality and bolster application resilience.
+- Updated the Docker and Kubernetes example READMEs with detailed instructions on configuring Prometheus and Grafana seamlessly.
+- Enhanced clarity of instructions in the `@chronosmicro/tracker` NPM package's README, offering comprehensive guidance on utilizing the package to monitor individual applications effectively.
+
+<a href="https://chronoslany.com/">
+    <img src="assets/demo.gif" alt="Chronos" title="Chronos" align="center" height="500" width="auto" />
+</a>
+
+<br>
 
+**Previously implemented updates:**
 - Added interactive charting to better visualize metrics and increase user engagement with their data
 - Followed best test-driven development practices and increased testing with React Testing and Jest for the front end
 - Overhauled user database security, mitigating database breaches and providing a safer experience
 - Bug fixes and UI tweaks, creating a more pleasant user experience
 - Updated outdated README instructions within the provided Docker, gRPC, Kubernetes, and microservices examples
 - Revised README instructions for the `@chronosmicro/tracker` NPM package
 
-
-**Previously implemented updates:**
-- Streamlined approach to access and dynamically display Grafana dashboards for deployed EKS clusters (utilizing Prometheus data scraping and generated Grafana dashboards) using the Grafana API.
-- Option to choose between cloud hosted services and local services, giving Chronos the ability to monitor instances and clusters on AWS' EC2, ECS, and EKS platforms.
-- An updated AWS Graphs Container to dynamically render plots for EC2 or ECS data fetched with Electron using event listeners connecting to AWS CloudWatch w/ the aws-sdk package, as well as utilizing Prometheus data scraping and Grafana integration to fetch and render EKS data.
-- Step-by-step instructions on setting up a new, functional EC2 instances, ECS clusters, and EKS clusters, ready to be monitored and tested by the app.
-
 ## Features
 
 - Cloud-Based Instances:
@@ -45,15 +52,15 @@ Chronos is a comprehensive developer tool that monitors the health and web traff
     - Enables distributed tracing enabled across microservices applications
     - Displays real-time temperature, speed, latency, and memory statistics for local services
     - Displays and compares multiple microservice metrics in a single graph
-    - Allow Kubernetes monitoring via Prometheus server
+    - Allow Kubernetes and Docker monitoring via Prometheus server and Grafana visualization.
     - Compatible with <img src="assets/graphql-logo-color.png" alt="GraphQL" title="GraphQL" align="center" height="20" /></a>
     - Monitor an <a href="#"><img src="assets/pngwing.com.png" alt="Apache Kafka" title="Apache Kafka" align="center" height="20" /></a> cluster via the JMX Prometheus Exporter
     - Supports <a href="#"><img src="assets/postgres-logo-color.png" alt="PostgreSQL" title="PostgreSQL" align="center" height="20" /></a> and <img src="assets/mongo-logo-color.png" alt="MongoDB" title="MongoDB" align="center" height="20" /></a> databases
 
 
 # Installation
 
-This is for the latest Chronos **version 11.0 release**.
+This is for the latest Chronos **version 12.0 release**.
 
 ## NPM Package
 
@@ -68,6 +75,7 @@ For more details on the NPM package and instructions for how to use it, please v
 #
 
 <!-- ### Node Version -->
+<!-- v12 notes: Our team also had no issues - we ran Node 18 and Electron 22-->
 <!-- v11 notes: Our team also had no issues - we ran Node 18.-->
 <!-- v10 notes: Our team never reverted to version 16.17.1 and had no issues running Node 18 and Electron 22 together. Commenting this out for future iteration teams' reference. -->
 <!-- Make sure you're running version 16.17.1 of <img src="assets/node-logo-color.png" alt="Node" title="Node" align="center" height="20" />, to align with the <img src="assets/node-logo-color.png" alt="Node" title="Node" align="center" height="20" /> version used by <img src="assets/electron-logo-color.png" alt="Electron" title="Electron" align="center" height="20" /> version 22. -->
@@ -106,6 +114,7 @@ export DISPLAY="`sed -n 's/nameserver //p' /etc/resolv.conf`:0"
 2. Run `npm run build`
 3. Open a new terminal and run `npm run dev:app` to start the Webpack development server
 4. Open a new terminal and run `npm run dev:electron` to start the Electron UI in development mode
+.
 #
 ### Packing the Chronos desktop app into an executable
 
@@ -163,7 +172,7 @@ Refer to the [gRPC README](./examples/gRPC/README.md) in the `gRPC` folder for m
 
 #### _Kubernetes_
 
-The `kubernetes` folder includes a React frontend and an Express server backend, and the Dockerfiles needed to containerize them for Kubernetes deployment. The _launch_ folder includes the YAML files needed to configure the deployments, services, and configurations of the frontend, backend, and Prometheus server.
+The `kubernetes` folder includes a React frontend and an Express server backend, and the Dockerfiles needed to containerize them for Kubernetes deployment. The _launch_ folder includes the YAML files needed to configure the deployments, services, and configurations of the frontend, backend, Prometheus server, and Grafana.
 
 Refer to the [Kubernetes README](./examples/kubernetes/README.md) in the `kubernetes` folder for more details.
 
@@ -178,7 +187,7 @@ Refer to the [microservices README](./examples/microservices/README.md) in the `
 
 # Testing
 
-We've created testing suites for Chronos with React Testing and Jest - instructions on running them can be found in the [testing README](./__tests__/README.md).
+We've created testing suites for Chronos with React Testing, Jest, and Selenium for unit, integration, and end-to-end tests - instructions on running them can be found in the [testing README](./__tests__/README.md).
 #
 ## Contributing
 
@@ -188,12 +197,11 @@ Read our [contributing README](../../CONTRIBUTING.md) to learn how you can take
 
 ### **Last Iterating Team**
 
-#### Chronos 11.0
-- [Lucie Seidler](https://github.com/LucieSeidler)
-- [Jeffrey Na](https://github.com/jeffreyNa)
-- [Brisa Zhu](https://github.com/beezoo10)
-- [Kelsi Webb](https://github.com/kelsicw)
-- [Justin Poirier](https://github.com/jcpoirier20)
+#### Chronos 12.0
+- [Tyler Coryell](https://github.com/Tcoryell)
+- [Edwin Leong](https://github.com/edwinlny)
+- [Eisha Kaushal](https://github.com/eishakaushal)
+- [Haoyu Liu](https://github.com/HaoyL666)
 
 
 #### Past [Contributors](contributors.md)
@@ -219,6 +227,14 @@ Read our [contributing README](../../CONTRIBUTING.md) to learn how you can take
 - <a href="#"><img src="assets/vis-logo-color.png" alt="Vis.js" title="Vis.js" align="center" height="30" /></a>
 - <a href="#"><img src="assets/plotly-logo-color.png" alt="Plotly.js" title="Plotly.js" align="center" height="30" /></a>
 - <a href="#"><img src="assets/pngwing.com.png" alt="Apache Kafka" title="Apache Kafka" align="center" height="30" /></a>
+- <a href="#"><img src="assets/grafana-logo.png" alt="Grafana" title="Grafana" align="center" height="40" /></a>
+- <a href="#"><img src="assets/selenium-logo.png" alt="Selenium" title="Selenium" align="center" height="30" /></a>
+- <a href="#"><img src="assets/prometheus-logo.png" alt="Prometheus" title="Prometheus" align="center" height="40" /></a>
+- <a href="#"><img src="assets/github-action-logo.png" alt="Github Action" title="Github Action" align="center" height="40" /></a>
+- <a href="#"><img src="assets/threeJS-logo.png" alt="Github Action" title="Github Action" align="center" height="40" /></a>
+- <a href="#"><img src="assets/kubernetes-log.png" alt="Kubernetes" title="Kubernetes" align="center" height="40" /></a>
+
+
 
 
 ## License