🧠 my-redis

A minimalist Redis clone written in Go, implementing the RESP2 protocol from scratch.
This project serves as a deep dive into building low-level systems and understanding the inner workings of Redis.

---

🚀 Features

• Custom RESP2 (Redis Serialization Protocol) parser.
• Support for core Redis data types:
  • Simple Strings (+OK)
  • Errors (-ERROR)
  • Integers (:100)
  • Bulk Strings ($6\r\nfoobar\r\n)
  • Arrays (*2\r\n$3\r\nfoo\r\n$3\r\nbar\r\n)
• Basic command parsing and response handling.
• Modular codebase with clear separation of concerns.

---

📁 Project Structure

my-redis/
├── command/        # Command parsing and execution
├── resp/           # RESP2 protocol implementation
├── server/         # TCP server setup and client handling
├── store/          # In-memory data storage
├── utils/          # Utility functions
├── main.go         # Entry point of the application
├── go.mod          # Go module file
└── README.md       # Project documentation

---

🛠️ Getting Started

Prerequisites

• Go 1.20 or higher installed on your machine.

Installation

# Clone the repository
git clone https://github.com/DNahar74/my-redis.git

# Navigate to the project directory
cd my-redis

# Build the application
go build -o my-redis.exe

# Run the application
./my-redis

---

🧪 Usage

Once the server is running, you can interact with it using telnet or any Redis client:

telnet localhost 6379

Example commands:

SET key value
GET key
DEL key

Note: Command support is currently limited as this is a work in progress.

---

🛠️ Implemented Commands

🟢 PING

• Description: Tests the connection with the server.
• Usage:

  PING

• Response:

  +PONG
  

---

🗣️ ECHO

• Description: Returns the input string.
• Usage:

  ECHO "hello world"

• Response:

  "hello world"
  

---

💾 SET

• Description: Stores a key with a string value. Optional expiry flag in seconds.
• Usage:

  SET hello world
  SET hello world EX 100  # Key expires in 100 seconds

• Response:

  +OK
  

---

📥 GET

• Description: Retrieves the value of the given key.
• Usage:

  GET hello

• Response (if found):

  "world"
  

---

❌ DEL

• Description: Deletes the specified key.
• Usage:

  DEL hello

• Response:

  +OK
  

---

📚 RESP2 Protocol Overview

The Redis Serialization Protocol (RESP) is a simple protocol used by Redis for client-server communication.
This project implements RESP version 2.

Simple Strings

• Format: +<string>\r\n

Errors

• Format: -<error message>\r\n

Integers

• Format: :<number>\r\n

Bulk Strings

• Format: $<length>\r\n<string>\r\n

Arrays

• Format: *<number of elements>\r\n<element1>\r\n<element2>\r\n...

For a more detailed explanation, refer to the Redis Protocol specification.

---

🧱 Contributing

Contributions are welcome!
If you'd like to add features, fix bugs, or improve documentation, please fork the repository and submit a pull request.

---

🙌 Acknowledgements

• Redis for the inspiration and protocol specification.
• Go Programming Language for its simplicity and performance.