cycap

README

[TOC]

Development

Directory Structure

• api: Root level of all Protocol Buffer files describing RPC communication
• cmd: Folders for each binary output
• internal: Go code that shouldn't be usable outside this project
• pkg: Go code that may be freely imported by external projects
• web: Hugo root

Build Process

• Containerfile: Container for server component
• Containerfile.build: Creates build environment for CI
• .gitlab-ci.yml: Uses build environment to run Makefile
• Makefile: Runs basic scripts to prepare and build code

Makefile

• make client: Builds client WebAssembly binary
• make server: Builds server container using Containerfile
• make fly: Deploys the server to Fly.io
• make test: Runs all Go tests
• make hugo: Build static website using Hugo
• make local: Runs the server and static website for local testing
• make pages: Create static website then compresses resources using Gzip and Brotli to be served by GitLab
• make protobuf: Generate code from Protocol Buffer files in api

Documentation

Overview

Package cycap implements a WASM gRPC client and server for cycap