https://github.com/anish15ag/build-your-own-redis

A minimal Redis-like key-value store implemented in JavaScript and Node.js, using hashmaps for data storage and the redis-parser package for command parsing. Ideal for educational purposes, this project offers a simple interface for basic Redis functionalities, with plans to expand its features in the future.
https://github.com/anish15ag/build-your-own-redis

node-js redis redis-client redis-server

Last synced: 18 days ago
JSON representation

A minimal Redis-like key-value store implemented in JavaScript and Node.js, using hashmaps for data storage and the redis-parser package for command parsing. Ideal for educational purposes, this project offers a simple interface for basic Redis functionalities, with plans to expand its features in the future.

• Host: GitHub
• URL: https://github.com/anish15ag/build-your-own-redis
• Owner: Anish15AG
• Created: 2024-10-16T18:14:17.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-10-16T19:20:09.000Z (3 months ago)
• Last Synced: 2024-10-18T17:28:27.396Z (3 months ago)
• Topics: node-js, redis, redis-client, redis-server
• Language: JavaScript
• Homepage:
• Size: 14.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Build Your Own Redis Service  

A minimal Redis clone built using **JavaScript** and **Node.js**. This project provides a basic subset of the core Redis functionality, using **hashmaps** for key-value storage. It utilizes the `redis-parser` package to handle protocol parsing, allowing communication through a Redis-like CLI interface.  

⚠️ **Note**: This project is for **educational purposes only** and lacks advanced features of the official Redis service (like concurrency, master-slave configuration, and sorting algorithms). Make sure to uninstall this implementation from your system after you're done exploring it.

---

## Features

- **Key-Value Storage:** Supports `SET` and `GET` commands using hashmaps.

- **Redis Protocol Parser:** Uses the `redis-parser` package for request parsing.

- **Simple Node.js Implementation:** Built with minimal dependencies.

- **Expandable:** Aims to add more Redis-like features in the future.

---

## Getting Started  

Follow the instructions below to install and run the service on your local machine.

### Prerequisites  

- **Node.js** (v12+ recommended)  

- **npm** (for package management)

### Installation  

1. **Clone the repository**:

   ```bash

   git clone https://github.com/Anish15AG/Build-your-own-REDIS.git

   cd your-redis-clone

2. **Install Dependencies**:

    ````bash

    npm install redis-parser

3. **Run the Server**:

    ````bash

    node index.js

3. **Use the Redis CLI: In a separate terminal window, connect to the Redis service via:**:

    ````bash

    redis-cli -p 8000

---

### Current Limitations

This Redis clone is a **work-in-progress** and currently lacks several functionalities found in the full Redis implementation:

*   **Sorting algorithms** (e.g., ZSETs) are not implemented.

    

*   **Concurrency and multi-threading** features are not supported (currently single-threaded).

    

*   **Persistence** mechanisms like **snapshotting** or **AOF** (Append-Only File) are missing.

    

*   **Master-slave replication** and **cluster mode** are not implemented.

    

*   **Pub/Sub messaging** functionality is currently not available.

    

These features may be considered in future updates to bring the service closer to the real Redis.

---

### Uninstall Instructions

If you no longer need this Redis clone, follow these steps to uninstall it:

1.  **Stop the server**

    ````

    bash 

    Ctrl + C

    

2.  **Remove Repository and Files** 

    ````

    bash 

    cd ..rm -rf your-redis-clone