TinyCache - A Lightweight Cache

TinyCache is an efficient, lightweight caching system designed to provide easy and fast data storage and retrieval. This project is currently in progress and open for contributions!

Roadmap

Milestone 1: Basic Cache System (Completed ✅)

• Cache server and client: Set up a cache server that handles requests and a client that interacts with the server to store and retrieve data.
• RESP: Build a simple communication protocol to send and receive data.
• In-memory cache storage: Implement basic commands(like PING, SET, GET etc.) to create a basic caching system.
• Thread-safe operations: Ensure that the cache works correctly in programs with multiple tasks running at the same time.
• Unit tests: Write tests to make sure all parts of the cache work as expected.

Milestone 2: Feature Expansion (In Progress 🚧)

• TTL (Time-to-Live): Add a feature that automatically removes cached data after a set time.
• LRU (Least Recently Used) eviction policy: Automatically remove the least used items when the cache gets full.
• LFU (Least Frequently Used) eviction policy: Add an LFU eviction policy to remove the least frequently used items when the cache is full, providing an alternative to LRU.

Milestone 3: Advanced Features (Planned 🛠️)

• Pluggable storage backends: Allow users to store cache data in different places (e.g., in a file or a database like Redis).
• Persistent storage: Ensure that cached data remains available even after the program restarts.

🚀 How to Run the Project 🛠️

Prerequisites

To run TinyCache, make sure you have the following installed on your machine:

• Go 1.22 or higher. You can download Go from here.

Verify your Go version using:

go version

Running the Project

1. Clone the repository or download it manually:

   git clone https://github.com/nahK994/TinyCache.git
   cd TinyCache
   

2. Use the run.sh script to manage the server and client. This script provides options to start the server, client, playground, and more.

3. Run the following command to start the script:

   bash run.sh
   

4. You will be presented with the following options:

   1) Start server
   2) Start client
   3) Start playground
   4) Kill running server and client
   5) Run test
   6) Run build
   Type: 
   

5. Type 1 to start the server, or 2 to start the client.

6. To stop any running process, select the Kill process option by typing 4.

7. To run the tests, type 5 and press enter.

8. Type 6 to build binaries for client and server.

📥 Installation

If you'd like to install TinyCache on Linux without cloning the repository, use the following command to install both the server and client:

curl -fsSL https://raw.githubusercontent.com/nahK994/TinyCache/master/install.sh | bash

This will download the binaries, install them to the appropriate locations, and set up the server as a systemd service.

🧹 Uninstallation

To uninstall from linex TinyCache, simply run the following command:

curl -fsSL https://raw.githubusercontent.com/nahK994/TinyCache/master/uninstall.sh | bash

This will stop the service, remove the binaries, and clean up all installed files.

📦 Project Structure Overview

This project is organized into several directories to maintain a clean and modular structure. Below is a breakdown of each folder and its purpose:

cmd Contains the entry points for running different components of the project.

• server: The main server application.
• client: The client application to communicate with the server.
• playground: A playground for testing and experimenting with features.

connection Handles server and client connections.

• server: Manages server-side connections.
• client: Manages client-side connections.

pkg Contains core logic and utilities used across the project.

• utils: General utility functions used across the project.
• resp: Handles RESP serializing and deserializing logic.
• cache: Contains caching logic.
• errors: Contains custom error definations.
• handlers: Contains the request handlers.

tests Includes unit tests for different components.

• resp: Tests for RESP command handling.
• cache: Tests for caching functionality.

🤝 Contributing

We welcome contributions of all kinds! Whether you're fixing bugs, adding new features, or improving documentation, your input is appreciated. Please follow our contribution guideline.

📬 Contact

If you have any questions, feel free to reach out via GitHub Issues or email at [email protected].

📝 License

This project is open-source and available under the MIT License.