base on DiceDB is an open source, redis-compliant, reactive, scalable, highly-available, unified cache optimized for modern hardware. DiceDB === <a href="https://dicedb.io"></a> <a href="https://dicedb.io/get-started/installation/"></a> <a target="_blank" href="https://discord.gg/6r8uXWtXh7"><img src="https://dcbadge.limes.pink/api/server/6r8uXWtXh7?style=flat" alt="discord community" /></a> DiceDB is an open source, redis-compliant, reactive, scalable, highly available, unified cache optimized for modern hardware. > [!CAUTION] > DiceDB is under active development and supports a subset of Redis commands. Inconsistent behavior is expected. Feel free to go through the [open issues](https://github.com/DiceDB/dice/issues) and contribute to help us speed up the development. ## Want to contribute? We have multiple repositories where you can contribute. So, as per your interest, you can pick one and build a deeper understanding of the project on the go. - [dicedb/dice](https://github.com/dicedb/dice) for core database features and engine / Stack - Go - [dicedb/dicedb-cli](https://github.com/dicedb/dicedb-cli) command line interface for DiceDB / Stack - Go - [dicedb/playground-mono](https://github.com/dicedb/playground-mono) backend APIs for DiceDB playground / Stack - Go - [dicedb/alloy](https://github.com/dicedb/alloy) frontend and marketplace for DiceDB playground / Stack - NextJS ## Get started ### Setting up DiceDB with Docker The easiest way to get started with DiceDB is using [Docker](https://www.docker.com/) by running the following command. ```bash docker run -p 7379:7379 dicedb/dicedb --enable-watch ``` The above command will start the DiceDB server running locally on the port `7379` and you can connect to it using [DiceDB CLI](https://github.com/DiceDB/dicedb-cli) and SDKs. > [!TIP] > Since DiceDB is a drop-in replacement for Redis, you can also use any Redis CLI and SDK to connect to DiceDB. ## Supporters [](https://jb.gg/OpenSourceSupport) ### Setting up DiceDB from source for development and contributions To run DiceDB for local development or running from source, you will need 1. [Golang](https://go.dev/) 2. Any of the below supported platform environments: 1. [Linux based environment](https://en.wikipedia.org/wiki/Comparison_of_Linux_distributions) 2. [OSX (Darwin) based environment](https://en.wikipedia.org/wiki/MacOS) 3. WSL under Windows ```bash git clone https://github.com/dicedb/dice cd dice go run main.go --enable-watch ``` You can skip passing the flag if you are not working with `.WATCH` feature. 1. Install GoLangCI ```bash sudo su curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b /bin v1.60.1 ``` ### Live Development Server DiceDB provides a hot-reloading development environment, which allows you to instantly view your code changes in a live server. This functionality is supported by [Air](https://github.com/air-verse/air) To Install Air on your system you have the following options. 1. If you're on go 1.22+ ```bash go install github.com/air-verse/air@latest ``` 1. Install the Air binary ```bash # binary will be installed at $(go env GOPATH)/bin/air curl -sSfL https://raw.githubusercontent.com/air-verse/air/master/install.sh | sh -s -- -b $(go env GOPATH)/bin ``` Once `air` is installed you can verify the installation using the command `air -v` To run the live DiceDB server for local development: ```bash git clone https://github.com/dicedb/dice cd dice air ``` ### Local Setup with Custom Config By default, DiceDB will look for the configuration file at `./dicedb.conf`. (Linux, Darwin, and WSL) > [!TIP] > If you want to use a custom configuration file, you can specify the path using the `-c` flag. and to output the configuration file to a specific location, you can specify the output dir path using the `-o` flag. ### Setting up CLI The best way to connect to DiceDB is using DiceDB CLI and you can install it by running the following command ```bash sudo su curl -sL https://raw.githubusercontent.com/DiceDB/dicedb-cli/refs/heads/master/install.sh | sh ``` ### Client Compatibility DiceDB is fully compatible with Redis protocol, allowing you to connect using any existing Redis client or SDK. > [!NOTE] > The `.WATCH` feature is only accessible through the DiceDB CLI. > If you are working on unsupported OS (as per above script), you can always follow the installation instructions mentioned in the [dicedb/cli](https://github.com/DiceDB/dicedb-cli) repository. ### Running Tests Unit tests and integration tests are essential for ensuring correctness and in the case of DiceDB, both types of tests are available to validate its functionality. For unit testing, you can execute individual unit tests by specifying the name of the test function using the `TEST_FUNC` environment variable and running the `make unittest-one` command. Alternatively, running `make unittest` will execute all unit tests. ### Executing one unit test ```bash TEST_FUNC=<name of the test function> make unittest-one TEST_FUNC=TestByteList make unittest-one ``` ### Running all unit tests ```bash make unittest ``` Integration tests, on the other hand, involve starting up the DiceDB server and running a series of commands to verify the expected end state and output. To execute a single integration test, you can set the `TEST_FUNC` environment variable to the name of the test function and run `make test-one`. Running `make test` will execute all integration tests. ### Executing a single integration test ```bash TEST_FUNC=<name of the test function> make test-one TEST_FUNC=TestSet make test-one ``` ### Running all integration tests ```bash make test ``` > Work to add more tests in DiceDB is in progress, and we will soon port the > test [Redis suite](https://github.com/redis/redis/tree/f60370ce28b946c1146dcea77c9c399d39601aaa) to this codebase to ensure full compatibility. ## Running Benchmark ```bash make run_benchmark ``` ## Getting Started To get started with building and contributing to DiceDB, please refer to the [issues](https://github.com/DiceDB/dice/issues) created in this repository. ## Docs We use [Astro](https://astro.build/) framework to power the [dicedb.io website](https://dicedb.io) and [Starlight](https://starlight.astro.build/) to power the docs. Once you have NodeJS installed, fire the following commands to get your local version of [dicedb.io](https://dicedb.io) running. ```bash cd docs npm install npm run dev ``` Once the server starts, visit http://localhost:4321/ in your favourite browser. This runs with a hot reload which means any changes you make in the website and the documentation can be instantly viewed on the browser. ### Docs directory structure 1. `docs/src/content/docs/commands` is where all the commands are documented 2. `docs/src/content/docs/tutorials` is where all the tutorials are documented ## The Story DiceDB started as a re-implementation of Redis in Golang with the idea of building a DB from scratch to understand the micro-nuances that come with its implementation. DiceDB isn’t just another database; it’s a platform purpose-built for the real-time era. As real-time systems become increasingly prevalent in modern applications, DiceDB’s hyper-optimized architecture is positioned to power the next generation of user experiences. ## How to contribute The Code Contribution Guidelines are published at [CONTRIBUTING/README.md](CONTRIBUTING/README.md); please read them before you start making any changes. This would allow us to have a consistent standard of coding practices and developer experience. Contributors can join the [Discord Server](https://discord.gg/6r8uXWtXh7) for quick collaboration. ## Contributors <a href = "https://github.com/dicedb/dice/graphs/contributors"> <img src = "https://contrib.rocks/image?repo=dicedb/dice"/> </a> ## Troubleshoot ### Forcefully killing the process ``` $ sudo netstat -atlpn | grep :7379 $ sudo kill -9 <process_id> ``` ", Assign "at most 3 tags" to the expected json: {"id":"11182","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"