Skip to content

maxbarsukov/radish-db

Repository files navigation

RadishDB logo

RadishDB

Yet Another Key–Value Database

GitHub Release GitHub License GitHub repo size
Elixir Markdown Coverage Status

What is RadishDB?

RadishDB is an in-memory distributed key-value data store that chooses Consistency over Availability using own implementation of Raft Consensus Algorithm.

Table of contents

  1. Updates
  2. Getting Started
    1. Pre-reqs
    2. Building and Running
  3. Testing
  4. Linting
  5. Contributing
  6. Code of Conduct
  7. Get in touch!
  8. Security
  9. Useful Links
  10. License

Updates

🎉 v0.1.0 has been released!

🔔 Dec. 28, 2024 (v0.1.0)

🚀 Getting Started

Pre-reqs

Make sure you have git installed.

TODO

Building and Running

TODO

✅ Testing

TODO

🎨 Linting

TODO


🤝 Contributing

Need help? See SUPPORT.md.

Hey! We're glad you're thinking about contributing to RadishDB! Feel free to pick an issue labeled as good first issue and ask any question you need. Some points might not be clear, and we are available to help you!

Bug reports and pull requests are welcome on GitHub at https://github.com/maxbarsukov/radish-db.

Before creating your PR, we strongly encourage you to read the repository's corresponding CONTRIBUTING.md or otherwise the "Contributing" section of the README.md.

⚖️ Code of Conduct

This project is intended to be a safe, welcoming space for collaboration, and everyone interacting in the RadishDB project's codebases, issue trackers, chat rooms and mailing lists is expected to adhere to the code of conduct.

📫 Get in touch!

💌 Want to make a suggestion or give feedback? Here are some of the channels where you can reach us:

  • Found a bug? Open an issue in the repository!
  • Want to be part of our Telegram community? We invite you to join our RadishDB Community Chat, where you can find support from our team and the community, but where you can also share your projects or just talk about random stuff with other members of the RadishDB community 😁!

🛡️ Security

RadishDB takes the security of our software products and services seriously. If you believe you have found a security vulnerability in any RadishDB-owned repository, please report it to us as described in our security policy.


🌐 Useful Links

Link Description
raft.github.io Raft Consensus Algorithm
raft.github.io/raft.pdf Original Paper: In Search of an Understandable Consensus Algorithm (Extended Version)
habr.com/ru/articles/469999/ How servers negotiate with each other: Raft distributed consensus algorithm
thesecretlivesofdata.com/raft/
deniz.co/raft-consensus/
Interactive Raft visualizations
erlang.org/doc/system/distributed.html About distributed Erlang systems

🪪 License

The project is available as open source under the terms of the MIT License.

Leave a star ⭐ if you find this project useful.


This project is published under MIT.
A maxbarsukov project.
- 🎉 -