v3/README.md

1.8 KiB

Roleypoly

https://roleypoly.com

Tame your Discord roles.

Need Help with Roleypoly?

📚 Please read through our community documentation. 😕 Still confused? Talk to us on Discord!

Developing

Roleypoly is a distributed system built with Go, React, Terraform, and Bazel.

This repo is currently being re-architected into a monorepo, so most processes might not be documented.

Quickstart

This repo can be quickly setup with VSCode Dev Containers or GitHub Codespaces. This will setup a fully featured Docker container for developing VSCode, including extensions.

If you'd like to not use either of those, it can be imported into your Docker host with bazel run //src/dev-container, or pulled from either roleypoly/dev-container:main or docker.pkg.github.com/roleypoly/roleypoly/dev-container:main. This use case is not actively investigated, but with tinkering, will work. Feel free to document this process and open a PR :)

Developing Design System Components

For working with the Roleypoly Design System...

Run:

  • yarn to install deps
  • yarn storybook to open storybook
  • bazel test //src/design-system/.... to test

Developing Backend Components

This process is currently rough and in-flux. Please bear with us as we figure it out.

  • bazel run //src/<service> to run the service
    • note this commonly needs configuration from environment.
  • bazel test //src/<service> to test

Things to Know

Bazel can make some tasks far harder normal. Ideally, these are automated over.

  • Updating go.mod?
    • Run go generate ./....