Skip to content

Latest commit

 

History

History
131 lines (84 loc) · 2.34 KB

README.md

File metadata and controls

131 lines (84 loc) · 2.34 KB
Raw

Okane



Open Source Love Build by Nikhil


Okane is a CLI 💻 application built using Cobra Go🚀 to help manage your expenses 💵


Technology Stack

Go gRPC Redis


Install CLI

go install github.com/NikhilSharma03/Okane/okanecli@latest

Now you can access CLI app using okanecli in your terminal


Setup and Installation

First install Protocol compiler

brew install protobuf

Now, install gRPC Go plugin

go install \
    github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latest \
    github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@latest \
    google.golang.org/protobuf/cmd/protoc-gen-go@latest \
    google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest

Then, add GOPATH in .bashrc file

export PATH=$PATH:$HOME/go/bin
export PATH=$PATH:/usr/local/go/bin

To generate proto

make generate-proto

Now, Add Environment Variables by creating a new .env file in root folder and add the contents following .env.example

Once you have added correct credentials, run the server using

make run-server

If using docker compose, then first build the image

make compose-dev-build

Now start the dev server

make compose-dev-up

To access logs

make compose-dev-logs

To shut down the server

make compose-dev-down

Now the server is running at localhost:8000

Now, Lets build the okane cli app

make build-cli

Now you can use the app

./okane_cli

License