yados

module
v0.0.0-...-7eb9833 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 8, 2022 License: Apache-2.0

README

yados

Yet Another Distributed Object Store Using RAFT consensus algorithm.

Go Actions Status

Docker Image CI

Go Report Card

Command Line Interface

Quick Start

Using Docker Compose is basically a two-step process:

wget https://raw.githubusercontent.com/davinash/yados/main/docker-compose.yaml
docker-compose up -d
docker ps -a 
Above command should show three container instances with name yados-1, yados-2 and yados-3 running
REST API Documentation

REST API

Developer Notes

How to build
1. Checkout the repository
2. Building using following command
   2.1 make
3. Run the tests using following command
   3.1 make test
4. Running single Test 
   4.1 TEST_NAME=<TestName> make test-single
Fixing some common lint errors
Error      : File is not `gofmt`-ed with `-s
Resolution : Run the gofmt tool on the file which is reported this error

Error      : File is not `goimports`-ed (goimports)
Resolution : Run following command for the file

$GOPATH/bin/goimports  -w <file-name> 

Directories

Path Synopsis
cmd
cli
Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag
Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag
internal
rpc
server
nolint
nolint
wal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL