Purger - Installation Guide

Welcome to Purger, a powerful data clean-up tool! This guide will walk you through the installation process to get Purger up and running on your system.

Prerequisites

Before you begin, make sure you have the following dependencies installed on your machine:

• Node.js (version 16.14.2 or higher)
• npm (Node Package Manager, included with Node.js)

Installation

Step 1:

Clone the repository to your local machine:

git clone https://github.com/vintage-creator/purger.git

Step 2:

Navigate to the project directory:

cd purger app

Step 3:

Install the required dependencies using npm:

npm install

This will install the necessary packages including:

• mongoose: Object Data Modeling (ODM) library for MongoDB
• nodemailer: Module for sending emails using Node.js
• redis: In-memory data store for caching
• treblle-sdk: SDK for integrating with Treblle error tracking and monitoring service
• uuid: Unique identifier generator
• dotenv: Environment variables management
• joi: Data validation library
• js-yaml: YAML parser and serializer
• jsonwebtoken: JSON Web Token implementation
• express: Fast, unopinionated web framework for Node.js
• cors: Cross-origin resource sharing middleware
• node-cron: Task scheduler for cron-like functionality
• commander: Command-line interface framework
• chalk: Terminal string styling for adding colors
• ora: Elegant terminal spinner
• pm2: Production process manager for Node.js applications

All the dependencies will be automatically downloaded and installed.

Step 4:

Configuration:

• Update the configuration files according to your environment and requirements.

Step 5:

Start the application:

npm start

This will start the Purger application and you will see the server running on the specified port

Congratulations! You have successfully installed Purger and it is now ready to use. Happy data clean-up!

Additional Information

For more detailed information on how to use Purger and its features, please refer to the Documentation.

Contributing

We welcome contributions from the community to help improve Purger. If you find any issues or have suggestions, please submit a pull request or open an issue on the GitHub repository.

Thank you for choosing Purger! We hope you find it helpful in managing your data clean-up tasks. If you have any questions or need further assistance, please don't hesitate to reach out.

Happy purging!