stockpile/README.md

3.4 KiB
Raw Permalink Blame History

Welcome to stockpile 👋

Version Documentation Maintenance License: MIT Twitter: BRAVO68WEB

A Tiny Redis Server with no external dependencies ...

Stockpile is a Tiny Redis Server, created from scratch in Node.js with only few dependencies. It is a work in progress, and is not yet ready for production use. It was initially a part of CodeCrafter's - Create Redis Challenge. But, I decided to make it a standalone project. I will be adding more features to it, and will be using it in my future projects. I will also be adding more tests to it. If you want to contribute, please feel free to do so.

🏠 Homepage

Usage

git clone  https://github.com/BRAVO68WEB/stockpile
cd stockpile
yarn
./spawn_redis_server.sh 

OR

Not test with ts release

npx @bravo68web/stockpile help

SDKs

ChangeLog

  • Mar 11, 2023 - Initial Commit
  • Mar 11, 2023 - Added SET, GET, DEL and PING commands
  • Mar 12, 2023 - Added ECHO, EXISTS, KEYS, APPEND, STRLEN commands
  • Mar 12, 2023 - Added INCR, DECR, INCRBY, DECRBY commands
  • MAR 14, 2023 - Added SETNX, SETRANGE, GETRANGE, MSET, MGET, FLUSHDB, FLUSHALL, DBSIZE, RANDOMKEY commands
  • MAR 15, 2023 - Added EXPIRE, TTL, PERSIST, EXPIREAT, PEXPIREAT, PERSIST, MOVE, SELECT commands
  • MAR 17, 2023 - Added Added feature to dump/restore data and AUH` command support
  • MAR 18, 2023 - Release v0.1.0 and Added npx support
  • MAR 19, 2023 - Added BSON for buffer support and Added /health endpoint for HTTP health check
  • MAR 19, 2023 - Dockerizing application
  • MAY 8, 2023 - Added Github Actions to Build Image to GitHub Container Registry
  • MAY 9, 2023 - Rewrite code to Typescript
  • ... more to come

Development

git clone https://github.com/BRAVO68WEB/stockpile.git
cd stockpile

Run tests

./spawn_redis_server.sh &
./test_local.sh

Author

👤 Jyotirmoy Bandyopadhayaya

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page.

Show your support

Give a if this project helped you!

📝 License

Copyright © 2023 Jyotirmoy "BRAVO68WEB" Bandyopadhayaya.

This project is MIT licensed.