DramaHarvester/README.MD

56 lines
1.2 KiB
Plaintext
Raw Normal View History

2024-03-19 05:16:12 +00:00
# Drama Harvester
## Introduction
Drama Harvester is a specialized tool designed to interface with rDrama's public APIs, retrieve content such as comments and posts, and publish them to Redis for caching and further processing. Its goal is to facilitate the real-time ingestion of rDrama content, serving as a foundational layer for applications requiring streamlined access to rDrama data.
## Features
- Retrieves comments and posts from rDrama's endpoints.
- Publishes content to Redis, ensuring efficient caching.
- Supports incremental fetching to minimize redundant data retrieval.
## Getting Started
### Prerequisites
- Node.js (version 14 or later recommended)
- Redis server instance
### Installation
1. Clone the repository:
```bash
git clone https://fsdfsd.net/J/DramaHarvester.git
```
2. Navigate to the project directory:
```bash
cd DramaHarvester
```
3. Install dependencies:
```bash
npm install
```
### Configuration
1. Copy the `.env.example` file to a new file named `.env`.
```bash
cp .env.example .env
```
2. Edit the `.env` file to include your Redis connection details and any other configuration variables.
### Running Drama Harvester
To start the application, run:
```bash
npm start