add more readme stuff

Author: Patrick Koss

Makefile

@@ -1,6 +1,9 @@
-run-all-docker:
+run-all-docker: run-zookeeper
 	docker-compose up router server server2 server3 server4 envoy
 
+run-zookeeper:
+	docker-compose up zoo1 zoo2 zoo3
+
 test:
 	for dir in $$(find . -type d); do \
 		if [ -f $$dir/Cargo.toml ]; then \

README.md

@@ -3,6 +3,7 @@
 </p>
 
 # PatrickDB
+
 ![Build Status](https://img.shields.io/travis/com/patrickkoss/patrick-db/master)
 ![Coverage](https://img.shields.io/codecov/c/github/patrickkoss/patrick-db)
 ![License](https://img.shields.io/github/license/patrickkoss/patrick-db)
@@ -11,9 +12,8 @@
 ![PRs](https://img.shields.io/github/issues-pr/patrickkoss/patrick-db)
 ![Forks](https://img.shields.io/github/forks/patrickkoss/patrick-db)
 ![Stars](https://img.shields.io/github/stars/patrickkoss/patrick-db)
-![Language](https://img.shields.io/github/languages/top/patrickkoss/patrick-db
 
-patrick-db is a simplified Rust-based database designed to demonstrate distributed database principles. This distributed
+PatrickDB is a simplified Rust-based database designed to demonstrate distributed database principles. This distributed
 key-value store employs Zookeeper for replication and partitioning. Data is stored in a row-based format using a
 file-based system.
 
@@ -24,7 +24,8 @@ patrick-db's storage and index engines can be integrated into other projects.
 
 ![Architecture](./media/architecture.png)
 
-Clients compatible with gRPC or REST can connect to patrick-db, such as the [cli](./server/src/client.rs) tool located in
+Clients compatible with gRPC or REST can connect to patrick-db, such as the [cli](./server/src/client.rs) tool located
+in
 the [server](./server) directory.
 
 Envoy, which serves multiple purposes, is used here to interchange REST and gRPC.
@@ -38,3 +39,24 @@ is chosen.
 
 The [database](server/src/server.rs) itself is a gRPC server that implements a file-based storage system. In its role as
 a leader, it replicates data to followers using statement replication.
+
+# Getting Started
+
+Start all components (Zookeeper, Envoy, Router, and two Partitions with one Leader and Replica) inside docker
+containers:
+
+```bash
+make run-all-docker
+```
+
+Lint all components:
+
+```bash
+make lint
+```
+
+Run all tests:
+
+```bash
+make test
+```

server/Makefile

@@ -66,3 +66,12 @@ PROTOC_GEN_GO_GRPC = bin/protoc-gen-go-grpc
 install-protoc-gen-go-grpc: $(PROTOC_GEN_GO_GRPC)
 $(PROTOC_GEN_GO_GRPC):
 	GOBIN=$(PWD)/bin go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
+
+run-router:
+	cargo run --bin router
+
+run-server:
+	cargo run --bin server
+
+run-follower:
+	cargo run --bin server -- --server-address="[::1]:50053" --server-url="http://[::1]:50053" --storage-file-name=patrick2.db

server/README.md

@@ -0,0 +1,46 @@
+# Introduction
+
+The server utilizes gRPC, implemented using [tonic](https://github.com/hyperium/tonic), and
+employs [buf](https://buf.build/docs/introduction) for downloading and compiling external dependencies. This includes
+tools like gnostic for OpenAPI generation and validate for validation purposes.
+
+For building, compiling, downloading, and generating all proto-related materials, execute the following command:
+
+```bash
+make build-proto
+``` 
+
+## Running the server
+
+To run any component in this directory ensure zookeeper is running with the following command:
+
+```bash
+cd .. && make run-zookeeper
+```
+
+To run the router execute the following command:
+
+```bash
+make run-router
+```
+
+To run the server execute the following command:
+
+```bash
+make run-server
+```
+
+Optionally, you can run another server as follower:
+
+```bash
+make run-follower
+```
+
+## Interacting with the server
+
+To interact with the server, you can use the cli tool:
+
+```bash
+cargo run --bin client -- add test test
+cargo run --bin client -- get test
+```