Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thinkbeforecoding/eskv
In-memory key/value and event store, for educational purposes
https://github.com/thinkbeforecoding/eskv
event-sourcing keyvaluestore
Last synced: about 1 month ago
JSON representation
In-memory key/value and event store, for educational purposes
- Host: GitHub
- URL: https://github.com/thinkbeforecoding/eskv
- Owner: thinkbeforecoding
- License: other
- Created: 2021-09-29T17:23:32.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-07T09:33:50.000Z (over 1 year ago)
- Last Synced: 2024-10-08T09:32:34.260Z (3 months ago)
- Topics: event-sourcing, keyvaluestore
- Language: F#
- Homepage:
- Size: 366 KB
- Stars: 17
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# _eskv_
[](https://github.com/thinkbeforecoding/eskv/actions/workflows/dotnet.yml)
_eskv_ is an in-memory key/value and event store, for educational purpose.
## Disclamer
**_eskv_ is not meant to be run in production**. _eskv_ has been created to ease the _learning_ of event sourcing. Use a production-ready event store for production.
## Getting Started
Install _eskv_ as a global dotnet tool:
``` bash
dotnet tool install eskv -g
```
for prerelease version, specify the `--prerelease` flag.
You can also install it as a local dotnet tool:
``` bash
dotnet new tool-manifest
dotnet tool install eskv
```
Then run it:
``` bash
eskv
```
or for a local dotnet tool:
``` bash
dotnet eskv
```
and open [http://localhost:5000](http://localhost:5000) in a browser to access the web ui.
## Usage
```
USAGE: eskv.exe [--help] [--endpoint ] [--dev] [--parcel ]
OPTIONS:
--endpoint eskv http listener endpoint. default is http://localhost:5000
--dev specify dev mode.
--parcel parcel dev server url. default is http://localhost:1234
--help display this list of options.
```
--endpoint < string >
: the eskv http listener endpoint. Use http://*:5000 to authorize connections over the network, or use it t change port. Default is http://localhost:5000
--dev
: activate development mode. Used only when working on _eskv_ UI development.
--parcel < string >
: The parcel dev server url used in development mode.
--help
: display help.
## eskv.client nuget
_eskv.client_ nuget contains _eskv_ client library to interact with _eskv_ server.
Add it to your project using the IDE, or the following command:
``` bash
dotnet add package eskv.client
```
In an F# script, you can reference it with a #r directive:
``` fsharp
#r "nuget: eskv.client"
```
Read the full [_eskv.client_ documentation](https://github.com/thinkbeforecoding/eskv/blob/main/docs/eskv.client.md).
## Copyright and License
Code copyright Jérémie Chassaing. _eskv_ and _eskv.client_ are released under the [Academic Public License](https://github.com/thinkbeforecoding/eskv/blob/main/LICENSE.md).