diff --git a/README.md b/README.md index b19b14d88..5b88d2849 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ -# Middleware - Open Source +# Middleware + +![Product Demo](media_files/product_demo_1.gif) + **Middleware** is an open-source tool designed to help engineering leaders measure and analyze the effectiveness of their teams using the DORA (DevOps Research and Assessment) metrics. The DORA metrics are a set of four key values that provide insights into software delivery performance and operational efficiency. They are: - **Deployment Frequency**: The frequency of code deployments to production or an operational environment. @@ -6,22 +9,43 @@ - **Mean Time to Restore**: The time it takes to restore service after an incident or failure. - **Change Failure Rate**: The percentage of deployments that result in failures or require remediation. -# Quick Start + +**Table of Contents** +- [Middleware - Open Source](#middleware) + - [Features](#features) + - [Quick Start](#quick-start) + - [Project Setup Guidelines](#project-setup-guidelines) + - [Using Docker](#using-docker) + - [Manual Setup](#manual-setup) + - [Contributing guidelines](#contributing-guidelines) + - [Security guidelines and disclosure](#security-guidelines-and-disclosure) + - [Installation](#installation) + - [Usage](#usage) + - [Examples](#examples) + - [Contributing](#contributing) + - [License](#license) + +## Features +- Integration with various CI/CD tools +- Automated collection and analysis of DORA metrics +- Visualization of key performance indicators +- Customizable reports and dashboards +- Integration with popular project management platforms + +## Quick Start Open the terminal and run the following command ```bash docker run \ --name middleware \ - -p 3000:3000 \ - -p 9696:9696 \ + -p 3000:3333 \ public.ecr.aws/y4x5l0o7/middleware:latest ``` -Wait for sometime for the services to be up.\ -\ -The frontend is available on your host at http://localhost:3005. \ -The backend is available on your host at http://localhost:9696. +Wait for sometime for the services to be up. + +The App shall be available on your host at http://localhost:3333. -# Project Setup Guidelines +## Project Setup Guidelines ### Using Docker 1. **Clone the Repository**: ```bash @@ -80,7 +104,7 @@ The backend is available on your host at http://localhost:9696. ``` ```bash # runs with the ssh tunnel - ./dev.sh -i /path/to/private_key -l 5433 -r staging_db.rds.amazonaws.com -p 5432 -u ec2-user -h 10.3.17.192 + ./dev.sh -i /path/to/private_key -l 5433 -r mhq_db.rds.amazonaws.com -p 5432 -u ec2-user -h 255.96.240.666 ``` ### Manual Setup @@ -113,24 +137,57 @@ To set up middleware locally, follow these steps: ``` 5. **Run the Project**: - - For backend: + - For backend analytics server: ```bash - python main.py + python app.py ``` + - For backend sync server: + ```bash + python sync_app.py + ``` - For frontend: ```bash npm start ``` 7. **Access the Application**: - Once the project is running, access the application through your web browser at `http://localhost:8000`. + Once the project is running, access the application through your web browser at http://localhost:8000. Additionally: + * The analytics server is available at http://localhost:5000. + * The sync server can be accessed at http://localhost:6000. + -# Contributing guidelines +## Contributing To get started contributing to middleware check out our [CONTRIBUTING.md](https://github.com/middlewarehq/middleware/blob/main/CONTRIBUTING.md). We appreciate your contributions and look forward to working together to make Middleware even better! -# Security guidelines and disclosure +## Security guidelines and disclosure To get started contributing to middleware check out our [SECURITY.md](https://github.com/middlewarehq/middleware/blob/main/SECURITY.md). We look forward to your part in keeping Middleware secure! + +## Usage +- Instructions for using the DORA metrics analyzer +- How to configure data sources and metrics collection +- Generating and interpreting reports +- Tips for optimizing DevOps performance based on insights + +## Examples +- Sample reports and dashboards showcasing DORA metrics +- Real-world use cases and success stories +- Screenshots of the analyzer in action + +## License +- Information about the project's license (e.g., MIT, Apache 2.0) +- Link to the full license text +- Any additional terms or conditions related to licensing + +## License +- Information about the project's license (e.g., MIT, Apache 2.0) +- Link to the full license text +- Any additional terms or conditions related to licensing + +![Product Screenshot](link_to_screenshot) + + + diff --git a/media_files/product_demo_1.gif b/media_files/product_demo_1.gif new file mode 100644 index 000000000..b6924ef09 Binary files /dev/null and b/media_files/product_demo_1.gif differ