📚 Update README with detailed instructions for running the backend, using the Gamemaster API, and managing API keys

This commit is contained in:
2026-01-28 19:00:08 +00:00
parent cbe874d3bd
commit 19a5d0f093

View File

@@ -44,12 +44,46 @@ A modern Vue 3 web application for Pokemon Professors to manage tournaments, pro
# Install dependencies
npm install
# Start development server (API key can be set via UI now!)
# Start development server WITH backend API:
npm run dev:full
# Or start just the frontend (no backend):
npm run dev
# Open browser to http://localhost:5173
```
**Backend Server**: When running `npm run dev:full`, the OAuth proxy and Gamemaster API start automatically on port 3001.
### Gamemaster API
The Gamemaster API provides access to Pokemon GO gamemaster data from PokeMiners:
```javascript
import { gamemasterClient } from './gamemaster-client.js';
// Get filtered pokemon (base forms + regional variants)
const pokemon = await gamemasterClient.getPokemon();
// Get all forms including costumes and variants
const allForms = await gamemasterClient.getAllForms();
// Get all moves
const moves = await gamemasterClient.getMoves();
// Check what's available
const status = await gamemasterClient.getStatus();
```
**Workflow**:
1. Open the **Gamemaster Manager** at `/gamemaster`
2. Click "Fetch from PokeMiners" to download latest data
3. Click "Process & Break Up Data" to categorize
4. Click "Save All Files to Server" to make available to all apps
5. Other apps can now access via the GamemasterClient
See [GAMEMASTER_API.md](GAMEMASTER_API.md) for full documentation and examples.
**API Key Setup** (two options):
1. **Option 1: UI-based (Recommended)** - Use the API Key Manager tool at `/api-key-manager` to store your key locally in the browser
2. **Option 2: Environment-based** - Create `.env` file (see Environment Setup section below) for CI/CD or shared development