Project Setup and Usage Guide

Installation

• Install the necessary dependencies:

  npm install

• Copy the example database configuration file:

  cp dbs.example.json ./dbs.json

• Edit the .env file to configure the schedule time and number of backups. Modify ./dbs.json to specify the databases and their settings.

• Build the project:

  npm run build

Running the Application

Start the Application

To start the application, use:

npm run app

Running the Application (Development Mode)

For running the app in development mode, use:

npm run start

Restoring a GZIP Backup

To restore a MongoDB database from a .gzip backup file, use the following command:

.\mongorestore.exe --db databaseName --uri "mongodb://username:password@localhost:27017/?directConnection=true&authSource=admin" --archive=.\databaseName.gzip --gzip

Make sure to replace:

databaseName with the actual name of your database, username and password with your MongoDB credentials. Running with Docker To run the project with Docker, use:

docker compose up

This command will start up the application and any related services defined in the docker-compose.yml file.