.devcontainer | ||
.github | ||
.storybook | ||
.vscode | ||
docs | ||
hack | ||
src | ||
terraform | ||
.babelrc.js | ||
.dockerignore | ||
.env.example | ||
.eslintrc.js | ||
.gitignore | ||
.prettierignore | ||
.prettierrc.js | ||
.stylelintignore | ||
.stylelintrc | ||
docker-compose.yaml | ||
go.mod | ||
go.sum | ||
jest.config.js | ||
LICENSE | ||
next-env.d.ts | ||
next.config.js | ||
package.json | ||
README.md | ||
tsconfig.json | ||
tsconfig.stories.json | ||
tsconfig.test.json | ||
vercel.json | ||
yarn.lock |
Roleypoly
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 TypeScript, React, Terraform, and Go.
This app is heavily edge computing-based with the backend being deployed via Cloudflare Workers, UI server on Google Cloud Run with 6 regions, and the mention responder in Google Compute Engine.
Extra Docs
- 👷♀️ Getting Started
- 🏭 Infrastructure
- 🧾 User Stories
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, a dev toolkit image can be pulled from ghcr.io/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 depsyarn storybook
to open storybookyarn test
to test
Developing App UI
For working with the Next.js frontend components...
Run:
yarn
to install depsyarn ui
to run Next.js dev serveryarn test
to test
Developing Backend Components
For working with Backend systems, you need Wrangler, and a setup script to help wtih config stuff :)
yarn setup-wrangler
to setup wrangler.tomlwrangler dev -e dev
to start a local preview deploymentyarn test
to test