Updated docs.
h3rald h3rald@h3rald.com
Sun, 20 Sep 2015 13:42:53 +0200
2 files changed,
27 insertions(+),
1 deletions(-)
M
admin/LiteStore_UserGuide.htm
→
admin/LiteStore_UserGuide.htm
@@ -117,6 +117,7 @@ <ul>
<li><a href="#Downloading.Pre-built.Binaries">Downloading Pre-built Binaries</a></li> <li><a href="#Installing.using.Nimble">Installing using Nimble</a></li> <li><a href="#Building.from.Source">Building from Source</a></li> + <li><a href="#Running.the.Administration.App">Running the Administration App</a></li> </ul> </li> <li><a href="#Usage">Usage</a>@@ -417,6 +418,20 @@ <ol>
<li>Download and install <a href="http://nim-lang.org/">Nim</a>.</li> <li>Clone the LiteStore <a href="https://github.com/h3rald/litestore">repository</a>.</li> <li>Run <span class="cmd">nim c litestore.nim</span> within the respository folder.</li> +</ol> + + +<h3 id="Running.the.Administration.App">Running the Administration App<a href="#document-top" title="Go to top"></a></h3> + +<p>A simple but functional Administration App is available to manage LiteStore, create documents interactively, view and search content, etc.</p> + +<p>To get the app up and running (assuming that you have the <span class="cmd">litestore</span> executable in your path):</p> + +<ol> +<li>Download the default <a href="https://github.com/h3rald/litestore/releases/download/v1.0.0/data.db">data.db</a> file. This file is a LiteStore data store file containing the sample app.</li> +<li>Go to the local directory in which you downloaded the <span class="cmd">data.db</span> file.</li> +<li>Run <span class="cmd">litestore -s:data.db</span></li> +<li>Go to <a href="http://localhost:9500/docs/admin/index.html">http://localhost:9500/docs/admin/index.html</a>.</li> </ol>
M
admin/md/getting-started.md
→
admin/md/getting-started.md
@@ -23,4 +23,15 @@ You can also build LiteStore from source, if there is no pre-built binary for your platform. All you have to do is the following:
1. Download and install [Nim](http://nim-lang.org/). 2. Clone the LiteStore [repository](https://github.com/h3rald/litestore). -4. Run [nim c litestore.nim](class:cmd) within the respository folder.+4. Run [nim c litestore.nim](class:cmd) within the respository folder. + +### 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](class:cmd) executable in your path): + +1. Download the default [data.db](https://github.com/h3rald/litestore/releases/download/v1.0.0/data.db) file. 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](class:cmd) file. +3. Run [litestore -s:data.db](class:cmd) +4. Go to <http://localhost:9500/docs/admin/index.html>.