Skip to content

Latest commit

 

History

History
73 lines (52 loc) · 2.25 KB

README.md

File metadata and controls

73 lines (52 loc) · 2.25 KB
Raw

DiceDB Playground Backend

DiceDB Playground is an interactive platform designed to let users experiment with DiceDB commands in a live environment, similar to the Go Playground. Allows users to search and play with various DiceDB commands in real-time.

This repository hosts backend service implementation of the Playground.

How to contribute

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.

Setting up this repository from source for development and contributions

To run playground-mono for local development or running from source, you will need

  1. Golang
  2. Any of the below supported platform environment:
    1. Linux based environment
    2. OSX (Darwin) based environment
    3. WSL under Windows
  3. Install GoLangCI
$ sudo su
$ curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b /bin v1.60.1

Steps to clone and run:

$ git clone https://github.com/dicedb/playground-mono
$ cd playground-mono
$ cp .env.sample .env
$ go run main.go

Running the Project Using Docker

1. Clone the repository:

git clone https://github.com/dicedb/playground-mono

2. Navigate to the project directory:

cd playground-mono

3. Copy the sample environment file:

cp .env.sample .env

This creates the .env file, which stores your environment variables. Make sure to update any necessary values inside this file before running the server.

4. Start the application using Docker Compose:

docker compose up -d

This command will pull any necessary Docker images, build the containers, and run them in detached mode (-d).

5. Verify the server is running:

Open your browser and go to:

http://localhost:8080/health

This endpoint should return a status indicating that the server is up and running.