DiceDB / docs

DiceDB Website, Blog, and Documentation.
https://dicedb.io/
16 stars 6 forks source link
database docs hacktoberfest

DiceDB Docs

Netlify Status Built with Starlight

DiceDB is an in-memory, real-time, and reactive database with Redis and SQL support optimized for modern hardware and building real-time applications. This repository holds the entire documentation hosted at dicedb.io.

Get started

We use Astro framework to power the dicedb.io website and Starlight to power the docs. Once you have NodeJS installed, fire the following commands to get your local version of dicedb.io running.

$ 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.

To build and deploy

$ npm run build

How to contributes

Guidelines

The Code Contribution Guidelines are published at CONTRIBUTING.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 for quick collaboration.

Directory structure

  1. src/content/docs/commands is where all the commands are documented
  2. src/content/docs/tutorials is where all the tutorials are documented

Contributors