mirror of
https://github.com/roleypoly/roleypoly.git
synced 2025-04-24 19:39:11 +00:00
chore: fix markdown prettier formatting
This commit is contained in:
parent
efe1e5ea5e
commit
9823670084
4 changed files with 45 additions and 19 deletions
|
@ -6,4 +6,12 @@ module.exports = {
|
||||||
trailingComma: 'es5',
|
trailingComma: 'es5',
|
||||||
bracketSpacing: true,
|
bracketSpacing: true,
|
||||||
semi: true,
|
semi: true,
|
||||||
|
overrides: [
|
||||||
|
{
|
||||||
|
files: '*.md',
|
||||||
|
options: {
|
||||||
|
tabWidth: 2,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
};
|
};
|
||||||
|
|
22
README.md
22
README.md
|
@ -21,9 +21,27 @@ This repo can be quickly setup with [VSCode Dev Containers](https://marketplace.
|
||||||
|
|
||||||
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 :)
|
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](https://ui.roleypoly.com)...
|
||||||
|
|
||||||
|
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
|
### Things to Know
|
||||||
|
|
||||||
Bazel can make some tasks far harder normal. Ideally, these are automated over.
|
Bazel can make some tasks far harder normal. Ideally, these are automated over.
|
||||||
|
|
||||||
- **Updating `go.mod`?**
|
- **Updating `go.mod`?**
|
||||||
- Run `hack/gazelle.sh` to regenerate `deps.bzl`.
|
- Run `go generate ./...`.
|
||||||
|
|
|
@ -4,9 +4,9 @@ This package houses the dev-container image.
|
||||||
|
|
||||||
It includes:
|
It includes:
|
||||||
|
|
||||||
- go (1.15.2)
|
- go (1.15.2)
|
||||||
- bazel (latest via bazelisk)
|
- bazel (latest via bazelisk)
|
||||||
- node (latest lts via nvm)
|
- node (latest lts via nvm)
|
||||||
|
|
||||||
As well as any other tooling within VSCode Dev Containers.
|
As well as any other tooling within VSCode Dev Containers.
|
||||||
|
|
||||||
|
@ -20,5 +20,5 @@ bazel run //srv/dev-container && docker run -it --rm bazel/src/dev-container:dev
|
||||||
|
|
||||||
To just use, this is published to two registries. There is no effective difference, except that GitHub's registry requires login, and Docker Hub does not.
|
To just use, this is published to two registries. There is no effective difference, except that GitHub's registry requires login, and Docker Hub does not.
|
||||||
|
|
||||||
- `docker pull roleypoly/dev-container:main`
|
- `docker pull roleypoly/dev-container:main`
|
||||||
- `docker pull docker.pkg.github.com/roleypoly/roleypoly/dev-container:main`
|
- `docker pull docker.pkg.github.com/roleypoly/roleypoly/dev-container:main`
|
||||||
|
|
|
@ -4,18 +4,18 @@ Service for handling Discord OAuth flow.
|
||||||
|
|
||||||
## Responsibilities
|
## Responsibilities
|
||||||
|
|
||||||
- Redirect users to relevant Discord OAuth page w/ state
|
- Redirect users to relevant Discord OAuth page w/ state
|
||||||
- Handle redirect from Discord OAuth flow and process the token
|
- Handle redirect from Discord OAuth flow and process the token
|
||||||
- Modify active session to include relevant data
|
- Modify active session to include relevant data
|
||||||
- v3: for parity, this is just user data
|
- v3: for parity, this is just user data
|
||||||
- _vNext: get guilds from oauth and cache_
|
- _vNext: get guilds from oauth and cache_
|
||||||
- _vNext: Source of truth for user guilds_
|
- _vNext: Source of truth for user guilds_
|
||||||
|
|
||||||
## Boundaries & Services
|
## Boundaries & Services
|
||||||
|
|
||||||
- **Inbound**
|
- **Inbound**
|
||||||
- HTTP: /discord-auth/\*
|
- HTTP: /discord-auth/\*
|
||||||
- gRPC: DiscordAuthService
|
- gRPC: DiscordAuthService
|
||||||
- **Outbound**
|
- **Outbound**
|
||||||
- Redis
|
- Redis
|
||||||
- gRPC: SessionService
|
- gRPC: SessionService
|
||||||
|
|
Loading…
Add table
Reference in a new issue