Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .jules/showcase.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
- **[2024-05-22]** Initial audit revealed `README.md` was functional but lacked "Curb Appeal". It missed critical link arrays, visual hooks, and a clear documentation map. Refactoring to follow the "Golden Template".
- **[2024-05-24]** Standardized "Quick Start" on `npm ci` rather than `npm install` for the TS monorepo. This prevents unintended local `package-lock.json` mutations, reducing onboarding friction and unexpected local state issues.
- **[2026-04-09]** Added `DISCORD_APPLICATION_ID` to Quick Start instructions. Users were encountering a startup crash when trying to run the bot with just `BOT_TOKEN` due to missing required application ID context, causing immediate abandonment.
- **[2026-07-09]** Updated the README to use `./setup.sh` instead of `npm ci` for installation to avoid missing dependencies like `ffmpeg`, and explicitly direct `.env` creation to `packages/bot/.env` to avoid dotenv loading errors, resolving a common UX onboarding friction.

## Showcase's Philosophy
- The README is not documentation; it is a Landing Page.
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,16 @@ Get up and running in less than 5 minutes.
```

2. **Install Dependencies**
This project uses `npm` workspaces.
This project uses `npm` workspaces and requires system dependencies.
```bash
npm ci
./setup.sh
```

3. **Configure Environment**
Create a `.env` file in the `packages/bot` directory (or the root directory):
Create a `.env` file in the `packages/bot` directory:
```bash
echo "BOT_TOKEN=your_token_here" > .env
echo "DISCORD_APPLICATION_ID=your_app_id" >> .env
echo "BOT_TOKEN=your_token_here" > packages/bot/.env
echo "DISCORD_APPLICATION_ID=your_app_id" >> packages/bot/.env
```

4. **Run the Bot**
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
160 changes: 80 additions & 80 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"eslint": "^9.28.0",
"jiti": "^2.6.1",
"typescript": "^5.9.3",
"typescript-eslint": "^8.35.0"
"typescript-eslint": "^8.63.0"
},
"scripts": {
"lint": "eslint packages/ --max-warnings 0",
Expand Down
2 changes: 2 additions & 0 deletions packages/shared/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ export type {
WoWGroupDict,
} from './types.js';

export type { SeasonPairs } from './seasonPairs.js';

export { CHARACTER_CLASSES, toCharacterClass, toRole, toUtility } from './types.js';

export { todayPST } from './dateHelpers.js';
Expand Down
Loading