https://github.com/satvikr/cyandb
A lightweight persistent key-value database written in go. Docs: https://pkg.go.dev/github.com/SatvikR/cyandb
https://github.com/satvikr/cyandb
database go key-value
Last synced: 6 months ago
JSON representation
A lightweight persistent key-value database written in go. Docs: https://pkg.go.dev/github.com/SatvikR/cyandb
- Host: GitHub
- URL: https://github.com/satvikr/cyandb
- Owner: SatvikR
- License: apache-2.0
- Created: 2020-11-14T01:46:00.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-16T03:47:13.000Z (about 5 years ago)
- Last Synced: 2025-11-22T14:57:14.102Z (7 months ago)
- Topics: database, go, key-value
- Language: Go
- Homepage: https://pkg.go.dev/github.com/SatvikR/cyandb
- Size: 83 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CyanDB
[](https://pkg.go.dev/github.com/SatvikR/cyandb)
## About
This is a lightweight key-value database written in go. CyanDB is persistent,
and is not an in-memory database.
## Project Status
This project is in early stages of development and should not be used in production
## To run
- Server:
```bash
# windows
cyand
# On linux/mac
sudo cyand
```
- Client
```bash
# windows/linux/mac
cyansh
```
## To install:
For all platforms: Make sure that your `GOBIN` directory, typically `~/go/bin/` is in your `PATH`
- Windows:
```bash
go get github.com/SatvikR/cyandb/cmd/cyand
go get github.com/SatvikR/cyandb/cmd/cyansh
```
- Linux/Mac:
```bash
go get github.com/SatvikR/cyandb/cmd/cyand
go get github.com/SatvikR/cyandb/cmd/cyansh
sudo cp $(which cyand) /usr/bin
```
## To compile from source:
From the root of the repository, run the following:
- Windows:
`.\make.bat install`
- Linux:
`make install`
## To compile for development:
From the root of the repository, run the following:
- Windows:
`.\make.bat`
- Linux:
`make`
Binaries will show up in `./bin` folder
## To clean binaries:
- Windows:
`.\make.bat clean`
- Linux:
`make clean`
## LICENSE
[Apache 2.0](https://github.com/SatvikR/cyandb/blob/master/LICENSE)
## FAQ
- Where does the name CyanDB come from?
- I was originally going to call this project BlueDB, but apparently that already existed.
When I asked one of my friends, [Alexandre](https://github.com/Alexandre2006), "What should I rename BlueDB to?", he replied "CyanDB."