https://github.com/opensourceraidguild/guild-scrivener
The scribe for various Guild Systems
https://github.com/opensourceraidguild/guild-scrivener
hacktoberfest
Last synced: 9 months ago
JSON representation
The scribe for various Guild Systems
- Host: GitHub
- URL: https://github.com/opensourceraidguild/guild-scrivener
- Owner: OpenSourceRaidGuild
- License: gpl-3.0
- Created: 2021-01-23T01:37:01.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-06-22T22:48:51.000Z (over 2 years ago)
- Last Synced: 2025-03-31T10:04:55.796Z (10 months ago)
- Topics: hacktoberfest
- Language: TypeScript
- Homepage:
- Size: 854 KB
- Stars: 3
- Watchers: 0
- Forks: 2
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Guild-Scrivener's Job
Currently
- Manages automation of editing & creating labels between repos using one repo as the source of truth.
- Raid stats coalescing, storage in FireStore & serving to frontend
### Environment Setup
Create a `.env` file
- `FIREBASE_PROJECT_ID` This can just be set to `raid-stats-c1d5a`
- `RAID_HOOK_SECRET` The Raid (Stats) Hooks' secret - see [GitHub Webhook Secret](https://docs.github.com/en/developers/webhooks-and-events/creating-webhooks)
- `LABEL_HOOK_SECRET` The Label Hooks' secret - see [GitHub Webhook Secret](https://docs.github.com/en/developers/webhooks-and-events/creating-webhooks)
- `AUTH` A [GitHub Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)
- `CURRENT_RAID_DISCORD_WEBHOOK_URL` The webhook URL for sending "current raid" messages
- `COMPLETED_RAID_DISCORD_WEBHOOK_URL` The webhook URL for sending "completed raid" messages
- `PORT` **_optional_** Only useful for production - not setting this uses port 5000
## Commands
### `firestore`
Starts the firestore emulator, and runs the provided script. The emulator is closed once the script has completed.
### `start`
Runs the server - needs to have been built first `npm run build`
### `local`
Runs dev server on `PORT` (or 5000 if not set) after starting the firestore emulator
### `build`
Builds the server using `tsc`
### `test`
Runs Jest in watch mode after starting the firestore emulator
### `test:ci`
Runs Jest while checking coverage