hbaas

module
v0.2.0 Latest Latest
Warning

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

Go to latest
Published: Aug 2, 2024 License: MIT

README

HBaaS

CI Quality Gate Status

HBaaS (Hackathon Backend as a Service) is a service that provides general-purpose backend functionalities tailored for hackathons. You can use HBaaS to quickly build a backend for your hackathon project.

We provide SDKs for various platforms such as Web, iOS, and Android.

Features

  • User Authentication
  • Leader Board
  • Realtime Messaging
  • Key-Value Store
  • File Storage
  • And more...

Getting Started

Prerequisites
  • Golang
  • Docker
  • Google Cloud SDK
Installation
# Prepare tools
make install-tools
docker-compose up -d

# Prepare application config
export HBAAS_CONFIG_FILEPATH=$(pwd)/config/default.json
# Optional: Use custom config file
cp config/default.json config/{custom_config_name}.json  
export HBAAS_CONFIG_FILEPATH=$(pwd)/config/{custom_config_name}.json
Start Server
make run-api-server

Directories

Path Synopsis
app
core/build_info
Package build_info
Package build_info
cmd
entrypoint
pkg
protobuf
api
bdd

Jump to

Keyboard shortcuts

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