gcordova/sonic-demo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Extend examples in README

Browse Source
This commit is contained in:
Gustavo Cordova Avila
2022-11-18 10:49:14 -08:00
parent 33e3198938
commit c5d61744d1
1 changed files with 15 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@@ -1,31 +1,28 @@
# SonicClient
This is a rudimentary [Sonic](https://github.com/valeriansaliou/sonic)
command-line client that I'm using to interact with a locally running
service.
This is a rudimentary [Sonic](https://github.com/valeriansaliou/sonic) command-line client that I'm using to interact with a locally running service.
## Server
You'll need a server running, to spin one up you can
use the `docker-compose.yml` file in the `demo`
directory, which pulls down the docker image from
the docker hub.
You'll need a server running, to spin one up you can use the `docker-compose.yml` file in the `demo` directory, which pulls down the docker image from the docker hub.
The required directory structure (`data/kv` and `data/fst`)
is already in place, so to spin it up you only need to:
The required directory structure (`data/kv` and `data/fst`) is already in place, so to spin it up you only need to:
```sh
$ docker-compose up -d; docker-compose logs -f
```
Press `^C` whenever you want to stop viewing the server's logs.
## Client
To build the client you need a [Nim](https://nim-lang.org/) compiler
for your target architecture; once it's available, along with the
`nimble` tool, you can build the client with:
To build the client you need a [Nim](https://nim-lang.org/) compiler for your target architecture; once it's available, along with the `nimble` tool; you can build the client with:
```sh
$ # Build with a locally set up Nim compiler
$ nimble build --verbose -d:release
```
and the binary will be left in the `./dist` directory.
## Usage
## Use
Once the client is build, run:
```
$ ./dist/sc --help
@@ -33,13 +30,10 @@ $ ./dist/sc --help
to display the commands and options required.
## Environment variables
The file `_envrc` contains an `.envrc` template for your
convenience; the client needs these three environment variables
set up so it knows what server to interact with:
The file `_envrc` contains an `.envrc` template for your convenience; the client needs these three environment variables set up so it knows what server to interact with:
* `SONIC_HOST`
* `SONIC_PORT`
* `SONIC_SECRET`
* `SONIC_HOST` - hostname or IP address of Sonic server
* `SONIC_PORT` - tcp port Sonic server is listening on
* `SONIC_SECRET` - password to connect to the server
You may use any method to set them up, and the `.envrc` method
is just a convenience for those that use `direnv`.
You may use any method to set them up, and the `.envrc` method is just a convenience for all `direnv` users.