UI Added to Git Hub project.

[mritsurgeon]

Project Summary

Original Project

The original project is a command-line interface (CLI) written in Go, designed for backing up code repositories from various sources, including GitHub. The CLI, when executed, performs repository backups and logs relevant information.

Forked Project (mritsurgeon/SourceCodeBackup)

This forked project extends the original CLI by providing a user-friendly web-based graphical user interface (GUI) for managing and visualizing the backup process. The UI is built using React for the frontend and Express (Node.js) for the backend.

Key Features and Components

Backend (Server.js)

WebSocket Communication

• Enables real-time communication between the server and clients using WebSockets.
• Maintains a WebSocket server for updating clients with log information during backup processes.

Log File Handling

• Manages a log file (history/history.log) to record server activities.

Backup Execution

• Implements a function (spawnGoProcess) to spawn a Go process for executing backups.
• Sends log data to connected WebSocket clients, ensuring real-time feedback.

Backup Statistics and Configuration Management

• Provides endpoints (/api/backupStatistics and /api/configFiles) for retrieving backup statistics and available YAML configuration files.

Frontend (App.js, wizard.jsx, history.jsx, summary.jsx, stats.jsx)

React Router and Material-UI

• Utilizes React Router for client-side routing, allowing users to navigate through different views.
• Implements Material-UI components for a clean and responsive layout.

Backup Configuration Wizard

• Offers a step-based wizard (StepWizard) for creating backup jobs with multiple configuration steps (Step1 to Step5).
• Configures routes for source, destination, scheduler, statistics, job list, and history.

Real-Time Log Updates

• Implements a WebSocket connection in history.jsx to receive real-time log updates from the server.

Summary Page

• Constructs a summary page (summary.jsx) that displays user inputs and allows users to initiate the backup process.

Backup Statistics

• Retrieves and presents backup statistics using Recharts for a clear visualization.

Purpose of the Forked Project

The primary purpose of this forked project is to enhance the original CLI by adding a user-friendly web-based interface for managing, configuring, and monitoring code repository backups. The UI streamlines the backup configuration process and provides real-time feedback on backup activities, enhancing the overall user experience.

Contribution Highlights

Web-Based GUI

• Introduces a web-based graphical user interface for a more accessible and interactive backup configuration.

Real-Time Feedback

• Implements real-time updates via WebSockets, keeping users informed about the progress of backup operations.

Backup Statistics

• Enhances the user experience with a statistical visualization of successful runs and backup durations.

• Configuration File Management

• Implements the creation of a new conf.yml file during the backup configuration process.

• Enables fetching and displaying existing conf.yml files in the job list (Jobs.jsx).

Initiate Run Feature

• Adds a new struct to the main Go application (gickup) to support imitating a backup run.
• Ensures proper handling of the struct during the execution of backup jobs.

Clean and Responsive Design

• Utilizes Material-UI for a clean and responsive design, ensuring a modern and intuitive user interface.

Additional Contributions and Future Work

Constants Refactoring

• Addresses the need for global configuration by refactoring static folder paths (const basedirectory + '/backups' and const BACKUP_ROOT_FOLDER = '/backups').
• Allows users to set these variables globally in the UI or via a configuration YAML file (conf.yml).

Future Work

• Further UI Enhancements: Continued refinement and expansion of the UI for an even more user-friendly experience.
• Comprehensive Backup Management: Exploration of additional features to provide comprehensive backup management capabilities.

[cooperspencer]

@mritsurgeon thanks for the UI, but there are a lot of git diffs in the files and you uploaded your log files

[cooperspencer]

I appreciate the effort you've put into this, but I won't merge it. Gickup will have a web UI in the future, but it needs to align with my comfort level and be something I can maintain independently.

[mritsurgeon]

I appreciate the effort you've put into this, but I won't merge it. Gickup will have a web UI in the future, but it needs to align with my comfort level and be something I can maintain independently.

Some Screenshots as a direction when you decide to code in your own ui

Screenshots:

List of all Jobs View ( With RUN NOW )

Step 1 Of create Job Wizard , Name & Descripton

Step 2 Of create Job Wizard , Source Selection

Step 2 Of create Job Wizard , Source Selection ( Settings Part 1 )

Step 2 Of create Job Wizard , Source Selection ( Settings Part 2 )

Step 3 Of create Job Wizard , Destination Selection

Step 3 Of create Job Wizard , Destination Selection ( Settings )

Step 4 Of create Job Wizard , Job Scheduler

Step 5 Of create Job Wizard , Summary ( Finish Action out to YML )

History of all Jobs Runs

Job Run Action History