getting-started.md

April 14, 2021 ยท View on GitHub

Getting Started

Downloading Pre-built Binaries

The easiest way to get LiteStore is by downloading one of the prebuilt binaries from the [Github Release Page][release]:

Running a Docker Image as a Container

Official Docker images are available on Docker Hub.

Just pull the latest version:

docker pull h3rald/litestore:v{{$version}}

then start a container to run the image on port 9500:

docker run -p 9500:9500 h3rald/litestore:v{{$version}} -a:0.0.0.0

%tip% Tip

The Dockerfile used to create tbe image is available in root of tbe LiteStore Github repository.

Installing using Nimble

If you already have Nim installed on your computer, you can simply run

nimble install litestore

Running the Administration App

A simple but functional Administration App is available to manage LiteStore, create documents interactively, view and search content, etc.

To get the app up and running (assuming that you have the litestore executable in your path):

  1. Extract the default data.db file included in the LiteStore release package. This file is a LiteStore data store file containing the sample app.
  2. Go to the local directory in which you downloaded the data.db file.
  3. Run litestore -s:data.db
  4. Go to localhost:9500/docs/admin/index.html.