https://github.com/loftwah/memchad
Memchad: A cool, custom fork of memcached. Cache like a boss with added fun and functionality.
https://github.com/loftwah/memchad
Last synced: 3 months ago
JSON representation
Memchad: A cool, custom fork of memcached. Cache like a boss with added fun and functionality.
- Host: GitHub
- URL: https://github.com/loftwah/memchad
- Owner: loftwah
- License: mit
- Created: 2024-08-20T08:40:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-20T10:50:29.000Z (about 1 year ago)
- Last Synced: 2025-03-07T03:03:58.604Z (7 months ago)
- Language: Shell
- Homepage:
- Size: 6.84 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Memchad 🕶️
[Memchad on Docker Hub](https://hub.docker.com/r/deanoloftwah/memchad)
**Memchad** is a custom fork of `memcached` that runs on the legendary port **42069**. Designed for high-performance caching, it adds a bit of fun and personality to your development environment. With its unique features and playful ASCII art, Memchad is more than just a caching solution—it's a statement.
## Features
- **Port 42069**: A memorable port for a memorable project.
- **ASCII Art and Fun**: Includes a custom welcome message with ASCII art, powered by `figlet`.
- **Easy Integration**: Works just like `memcached`, with an added twist of personality.
## Getting Started
### Prerequisites
To get started with Memchad, you'll need Docker installed on your machine. You can download it from the [official Docker website](https://get.docker.com).
### Build the Image
First, clone the repository and navigate to the project directory. Then build the Docker image:
```bash
git clone https://github.com/loftwah/memchad.git
cd memchad
docker build -t deanoloftwah/memchad:1.1.0 .
```
### Run the Container
Run the Memchad container and expose it on port 42069:
```bash
docker run -p 42069:42069 deanoloftwah/memchad:1.1.0
```
Once the container is running, you'll see a fun welcome message in your terminal, along with the ASCII art you've set up.
### Flex with Telnet 🦾
To show that Memchad is operating like the boss it is, you can flex with `telnet` to connect and throw down some commands. Here’s how the Chad does it:
1. **Roll up on Memchad using `telnet`:**
```bash
telnet localhost 42069
```
2. **Drop a key-value pair like a champ:**
After rolling in, you can set a key-value pair with this command:
```plaintext
set chadkey 0 60 5
hello
```
* `chadkey`: The key name—because Memchad holds the keys to the kingdom.
* `0`: Flags (set to 0, because we keep it simple).
* `60`: Expiration time in seconds—long enough to get things done.
* `5`: The byte count for the value (`hello`), because every byte counts.
* `hello`: The value, straight up.
3. **Pull that value like a pro:**
```plaintext
get chadkey
```
When you hit that, Memchad will flex back with:
```plaintext
VALUE chadkey 0 5
hello
END
```
That’s how you know Memchad is out here caching like a true Chad.
### Push to Docker Hub
To share your Memchad image with others, push it to Docker Hub:
```bash
docker push deanoloftwah/memchad:1.1.0
```
## Usage Example
You can integrate Memchad into your applications just like you would with `memcached`. Simply configure your application to connect to port 42069, and enjoy the added flair that Memchad brings to the table.
### Example Configuration in a Rails App
```ruby
# config/environments/production.rb
config.cache_store = :mem_cache_store, "memchad:42069",
{ namespace: 'myapp', expires_in: 1.day, compress: true }
```
## Contributing
Contributions are welcome! If you have ideas to make Memchad even more fun or functional, feel free to fork the repository, make your changes, and submit a pull request.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
This project is open-source and free to use, modify, and distribute under the MIT License.
## Acknowledgments
- Inspired by the need for more fun in the world of development tools.
- Thanks to the creators of `memcached` for the solid foundation.