castylab/api repository overview

⁠Casty API Server

This is a backend API server of Casty project written in go!

⁠

You can find API Documentations on Postman

⁠Requirements

• gRPC.server This project needs to connect to Casty gRPC server! More info⁠

⁠Configuraition

You should pass your configuration config.yml file to container to run!

⁠Config.yml

app:
  version: "0.1-dev"
  debug: true
  env: "dev"
grpc:
  host: "localhost"
  port: 55283
http:
  access_control_allow_origin: "*"
secrets:
  sentry_dsn: "" # optional
  hcaptcha_secret: "" # required if youre using this project with dashboard
storage_path: "/storage-volume-path"

grpc.host and grpc.port are the gRPC.server ip address and port that you should have! Casty gRPC.server⁠

secrets.hcaptcha_secret is hcaptcha secret key that you should set up on hcaptcha admin panel!

for more information about hcaptcha click here⁠

You're ready to Go!

⁠Create storage volume

$ docker volume create casty-storage

⁠Run container

$ docker run -dp 9002:9002 -v casty-storage:/{your-storage-path-in-config.yml-file} -v $PWD/config.yml:/code/config.yml castylab/api:<version>|latest

⁠Contributing

Thank you for considering contributing to this project!