BackupMonitoring

BackupMonitoring is a web application designed to schedule and perform automatic daily backups. It uses TypeScript, React, and a clean architecture, ensuring best practices and maintainability. The focus is on creating daily schedules to execute backups in specific locations with defined costs.

Technologies

• React with TypeScript for the front-end
• Node.js for scheduling and executing backups
• Clean Architecture: clear separation of layers

How to Run

1. Clone the repository:

   git clone https://github.com/Ruhtra/BackupMonitoring.git
   cd BackupMonitoring

2. Install dependencies:

   npm install

3. Configure your .env file according to the environment (development or production).

4. To run in development mode:

   npm run dev

5. To run in production mode:

   npm run start

Environment Configuration

The project relies on environment variables. Create a .env file with the following settings:

# Application Settings
PORT=                            # The port where the application will run
DATABASE_URL=                    # URL for the database connection

# Backup Directories
DB_DIR=                          # Comma-separated directories for backups
OUTPUT_DIR=                      # Output directory for the backup files

# Backup Configuration
BACKUP_NAMES=                    # List of backup names separated by commas
BACKUP_CRON=                     # CRON expression for backup scheduling
DAYS_TO_KEEP=                    # Number of days to keep backups

# File Transfer Settings
SEND_FILE=                       # Whether to send the backup files remotely
PATH_REMOTE=                     # Remote path for storing backups
SFTP_USER=                       # Username for SFTP connection
SFTP_HOST=                       # Host for SFTP connection
SFTP_PORT=                       # Port for SFTP connection

# SSH Configuration
SSH_KEY_PATH=                    # Path to the SSH private key for SCP connection

# Node Environment
NODE_ENV=                        # Set as 'development', 'production', or 'test'

Ensure that the BACKUP_NAMES do not contain duplicate names as this will cause an error.