mirror of
https://github.com/roleypoly/roleypoly.git
synced 2025-04-24 19:39:11 +00:00
Katalina
3291f9aacc
* miniflare init * feat(api): add tests * chore: more tests, almost 100% * add sessions/state spec * add majority of routes and datapaths, start on interactions * nevermind, no interactions * nevermind x2, tweetnacl is bad but SubtleCrypto has what we need apparently * simplify interactions verify * add brute force interactions tests * every primary path API route is refactored! * automatically import from legacy, or die trying. * check that we only fetch legacy once, ever * remove old-src, same some historic pieces * remove interactions & worker-utils package, update misc/types * update some packages we don't need specific pinning for anymore * update web references to API routes since they all changed * fix all linting issues, upgrade most packages * fix tests, divorce enzyme where-ever possible * update web, fix integration issues * pre-build api * fix tests * move api pretest to api package.json instead of CI * remove interactions from terraform, fix deploy side configs * update to tf 1.1.4 * prevent double writes to worker in GCS, port to newer GCP auth workflow * fix api.tf var refs, upgrade node action * change to curl-based script upload for worker script due to terraform provider limitations * oh no, cloudflare freaked out :(
120 lines
4.2 KiB
Markdown
120 lines
4.2 KiB
Markdown
# Roleypoly
|
|
|
|
https://roleypoly.com
|
|
|
|
Tame your Discord roles.
|
|
|
|
## Need Help with Roleypoly? 💁♀️
|
|
|
|
📚 [Please read through our community documentation.](https://github.com/roleypoly/community-docs)
|
|
|
|
😕 [Still confused? Talk to us on Discord!](https://discord.gg/PWQUVsd)
|
|
|
|
## 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 8 regions, and the mention responder in Google Compute Engine.
|
|
|
|
### Extra Development Docs
|
|
|
|
- 🏭 [Infrastructure](docs/infrastructure.md)
|
|
- 🧾 [User Stories](docs/user-stories.md)
|
|
|
|
### Quickstart
|
|
|
|
#### Option 1 🚀: E2E Dockerized Emulation
|
|
|
|
This is the fastest way to start. You must be using MacOS or Linux (WSL2 is ok!) for this to be successful.
|
|
|
|
- Setup `.env` using [`.env.example`][envexample] as a template and guide.
|
|
- When setting up your Discord Application, be sure to set `http://localhost:6609/login-callback` as the OAuth2 callback URL.
|
|
- Run: `yarn install`
|
|
- Run: `docker-compose up`
|
|
- This starts the UI and API servers in hot-reload dev/emulation mode. All changes to TS/TSX files should be properly captured and reloaded for you!
|
|
- Develop you a Roleypoly!
|
|
|
|
#### Option 2 🐱👤: Local Emulation
|
|
|
|
- With pre-requisites:
|
|
- Node.js 14, Yarn
|
|
- Setup `.env` using [`.env.example`][envexample] as a template and guide.
|
|
- When setting up your Discord Application, be sure to set `http://localhost:6609/login-callback` as the OAuth2 callback URL.
|
|
- Run: `yarn install`
|
|
- Run: `yarn start`
|
|
- This starts the Web UI, Storybook, and API servers in hot-reload dev/emulation mode. All changes to TS/TSX files should be properly captured and reloaded for you!
|
|
- Develop you a Roleypoly!
|
|
|
|
#### Option 3 🐄🤠: Wrangler (No emulation)
|
|
|
|
**Outdated. This won't work, but could give you an idea of what to do.**
|
|
|
|
This is probably extremely painful and requires you to have a Cloudflare account.
|
|
|
|
- With pre-requisites:
|
|
- Cloudflare Account
|
|
- Node.js 14, Yarn
|
|
- `npm i -g @cloudflare/wrangler`
|
|
- Do `wrangler init`, `wrangler login`, etc...
|
|
- Setup Wrangler for the project
|
|
|
|
- Change `account_id` to your Cloudflare Account ID in `wrangler.toml`
|
|
- Add a `dev` environment to `wrangler.toml`, using [`.env.example`][envexample] as a reference for how values should be set
|
|
|
|
- When setting up your Discord Application, be sure to set `http://localhost:8787/login-callback` as the OAuth2 callback URL.
|
|
|
|
```toml
|
|
[env.dev]
|
|
|
|
[env.dev.vars]
|
|
BOT_CLIENT_ID = ...
|
|
UI_PUBLIC_URI = "http://localhost:6601"
|
|
API_PUBLIC_URI = "http://localhost:8787"
|
|
ROOT_USERS = ...
|
|
```
|
|
|
|
- `wrangler secret put BOT_TOKEN -e dev`
|
|
- `wrangler secret put BOT_CLIENT_SECRET -e dev`
|
|
- Setup KV Namespaces -- Please follow the instructions listed after the command runs.
|
|
- `wrangler kvnamespace create -e dev KV_SESSIONS --preview`
|
|
- `wrangler kvnamespace create -e dev KV_GUILD_DATA --preview`
|
|
- `wrangler kvnamespace create -e dev KV_GUILDS --preview`
|
|
|
|
- Setup `.env` using [`.env.example`][envexample] as a template and guide.
|
|
- Run `yarn install`
|
|
- Run both `wrangler dev -e dev` and `yarn start:web`
|
|
- This starts the Web UI and API servers in hot-reload dev mode. All changes to TS/TSX files should be properly captured and reloaded for you!
|
|
- Develop you a Roleypoly
|
|
- And get a beer or heated plant because oh no.
|
|
|
|
### Developing Design System Components
|
|
|
|
For working with the [Roleypoly Design System](https://ui.roleypoly.com), use the below steps as reference. Code lives in `src/design-system` among elsewhere.
|
|
|
|
Run:
|
|
|
|
- `yarn` to install deps
|
|
- `yarn start:design-system` to open storybook
|
|
- `yarn test:design-system` to test
|
|
|
|
### Developing Web UI
|
|
|
|
For working with the Next.js frontend components, use the below steps as reference. Code lives in `src/web` among elsewhere.
|
|
|
|
Run:
|
|
|
|
- `yarn` to install deps
|
|
- `yarn start:web` to run Next.js dev server
|
|
- `yarn test:web` to test
|
|
|
|
### Developing API Components
|
|
|
|
For working with the API, use the below steps as reference. Code lives in `src/api`.
|
|
|
|
Run:
|
|
|
|
- `yarn` to install deps
|
|
- `yarn start:api` to start an emulated worker
|
|
- `yarn test:api` to test
|
|
|
|
[envexample]: .env.example
|