wunderDB is a JSON-based web-store to store an manage your data remotely and securely.

wunderDash is an official GUI Client that helps to manage your clusters on wunderDB, using an interactive interface. Built on ReactJS, wunderDash is fast and efficient with beautiful a UI.

To run the Client, locally, on your device, we recommend using the Docker Image.

Start the WunderDB server locally or use an hosted instance like wdb.tanmoysg.com. To run WDB Locally refer to it's official documentation.

Once WDB is up and running, get the URL and replace it in the Docker Compose File environment as

environment: 
    WDB_URL: "<WDB URL>"

Then run the docker-compose command to start the container.

docker-compose build
docker-compose up

It builds the React App while starting up and serve the built code using serve. Now you can use the wunderDash to interact with your data and clusters.

Please Note, that when you need to update/change the WDB URL, you'll need to update the docker-compose environment everytime. While starting up it builds the app with the new URL, so the Built React App may take some time to start, even though the container starts running.

Alternately, you can also run the project in memory. Clone the repository as

git clone https://github.com/TanmoySG/wunderDash
cd wunderDash

With the WDB URl, export it as an environment variable and run the Shell script to generate the WDB Config File in /src/assets directory and also to build the react app.

export WDB_URL="you.url.here:8000"
sh scripts/start-up.sh .

The code is built and you can find it in the /build directory. Now to run it, install Vercel Serve and run the serve command on the build directory to serve the Built wDash App.

npm install --global serve  
serve build