castylab/grpc repository overview

⁠Casty gRPC Server

• This is a gRPC server project written in go!

• What is gRPC and why we're using it? According to gRPC official website⁠:
  gRPC is a modern open source high performance RPC framework that can run in any environment. It can efficiently connect services in and across data centers with pluggable support for load balancing, tracing, health checking and authentication. It is also applicable in last mile of distributed computing to connect devices, mobile applications and browsers to backend services.

⁠Prerequisites

• First, ensure that you have installed Go 1.11 or higher since we need the support for Go modules via go mod. Go modules via go mod⁠

• mongodb This project uses mongodb as database connection! Mongodb official website⁠

⁠Clone the project

$ git clone https://github.com/CastyLab/grpc.server.git

⁠Configuraition

Make a copy of config.example.yml for your own configuration. save it as config.yml in your work directory.

$ cp config.example.yml config.yml

⁠Environments

⁠Mongodb configuration

Put your mongodb connection here

secrets:
  db:
    name: "casty"
    host: "localhost"
    port: 27017
    user: "service"
    pass: "super-secure-password"

⁠JWT configuration

We use JWT for our authentication method

secrets:
  jwt:
    expire_time: 60
    refresh_token_valid_time: 7
    private_key_path: "./config/jwt.key"
    public_key_path: "./config/jwt.pub"

to generate jwt [public/private] keys you can use ssh-keygen

$ ssh-keygen -t rsa -N '' -b 4096 -m PEM -f ./config/jwt.key &&\
    openssl rsa -in ./config/jwt.key -pubout -outform PEM &&\
    -out ./config/jwt.pub;

⁠Other environments

# Storage path is used for upload avatars, banners etc...
# This environment is useful for shared volumes between containers
storage_path: "your-storage-path"

# Sentry DSN path *optional
secrets:
    sentry_dsn: "your-sentry-project-dsn"

You're ready to Go!

⁠Run project with go compiler

you can simply run the project with following command

• this command with install dependencies and after that will run the project
• this project uses go mod file, You can run this project out of the $GOPAH file!

$ go run server.go

or if you're considering building the project use

$ go build -o server .

⁠or you can [Build/Run] docker image

$ docker build . --tag=casty.grpc

$ docker run -dp --restart=always 55283:55283 casty.grpc

⁠Contributing

Thank you for considering contributing to this project!