Skip to content

Repository files navigation

DevOps Dashboard

Project Overview

The DevOps Dashboard is a powerful tool designed to streamline CI/CD processes and provide real-time insights into workflow management. It integrates seamlessly with GitHub Actions and Jenkins to offer a comprehensive view of your CI/CD pipeline.

Features

  • Real-time Data Integration: Fetches and displays workflow data from GitHub Actions and build statuses from Jenkins.
  • RESTful API: Built with Express.js, providing endpoints for accessing workflow and build data.
  • Automated CI/CD Pipeline: Utilizes GitHub Actions to automate building, testing, and deploying applications.
  • Customizable Deployment: Easily integrate your deployment commands to suit your infrastructure needs.

Frontend

The DevOps Dashboard features an intuitive and responsive frontend UI, designed to provide a seamless user experience.

Technologies Used

  • Vite: For fast build and development.
  • React: To build reusable UI components.
  • CSS/SCSS: For styling and layout.

Key Features

  • Dashboard View: Displays real-time data from GitHub Actions and Jenkins.
  • Interactive Charts: Visualize workflow and build data with dynamic charts.
  • Responsive Design: Ensures compatibility across various devices and screen sizes.

Backend

The backend of the DevOps Dashboard is built with Node.js and Express.js, providing robust and scalable services.

Technologies Used

  • Node.js: For server-side scripting.
  • Express.js: To create RESTful APIs.
  • Axios: For making HTTP requests to external services.

Key Features

  • API Endpoints: Provides access to workflow and build data.
  • Webhook Integration: Handles real-time updates from GitHub.
  • Error Handling: Comprehensive error logging and handling mechanisms.

Installation

  1. Clone the repository:
    git clone https://github.com/thoufeekx/devops-example-project.git
  2. Navigate to the project directory:
    cd devops-example-project
  3. Install dependencies:
    npm install

Usage

  1. Start the server:
    npm start
  2. Access the dashboard at http://localhost:3001.

Environment Variables

Create a .env file in the devops-dashboard-backend directory with the following variables:

  • GITHUB_TOKEN: Your GitHub personal access token.
  • JENKINS_URL: The base URL for your Jenkins server.

Contribution Guidelines

We welcome contributions! Please fork the repository and submit a pull request for any improvements or bug fixes.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For questions or support, please contact Thoufeek.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages