fragginwagon/memory-infrastructure-palace
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

🚀 Simplify and streamline README with updated prerequisites, quick start instructions, and development commands

Browse Source
This commit is contained in:
Greg Jacobs
2026-01-28 23:01:02 +00:00
parent 29d9629a5d
commit dae271f8a8
1 changed files with 19 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
code/websites/pokedex.online/README.md
View File

@@ -21,83 +21,46 @@ See [PROGRESS.md](PROGRESS.md) for detailed development status.
- **Fast Performance** - Lazy loading, code splitting, and efficient caching - **Fast Performance** - Lazy loading, code splitting, and efficient caching
- **Accessible** - WCAG 2.1 Level AA compliance, keyboard navigation - **Accessible** - WCAG 2.1 Level AA compliance, keyboard navigation
## 🚀 Local Development ## 🚀 Quick Start
### Prerequisites ### Prerequisites
- Node.js 20+ - Node.js 18+
- npm or yarn - npm
- Challonge API key (get from https://challonge.com/settings/developer)
### Environment Setup ### Installation
1. **Copy environment template**:
```bash
cp .env.example .env
```
2. **Configure your API keys** in `.env`:
```bash
# Required: Get your API key from Challonge
VITE_CHALLONGE_API_KEY=your_actual_api_key_here
# Optional: Set default tournament for testing
VITE_DEFAULT_TOURNAMENT_ID=your_tournament_url
```
3. **Keep your `.env` file secure**:
- Never commit `.env` to git (already in `.gitignore`)
- Use `.env.example` for documentation
- Share API keys only through secure channels
### Quick Start
```bash ```bash
# Install dependencies # Install dependencies
npm install npm install
# Start development server WITH backend API: # Start development server
npm run dev:full
# Or start just the frontend (no backend):
npm run dev npm run dev
# Open browser to http://localhost:5173 # 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. ### Development Commands
### Gamemaster API ```bash
# Development with hot reload
npm run dev
The Gamemaster API provides access to Pokemon GO gamemaster data from PokeMiners: # Production build
npm run build
```javascript # Preview production build
import { gamemasterClient } from './gamemaster-client.js'; npm preview
// Get filtered pokemon (base forms + regional variants) # Run tests
const pokemon = await gamemasterClient.getPokemon(); npm test
// Get all forms including costumes and variants # Run tests with UI
const allForms = await gamemasterClient.getAllForms(); npm run test:ui
// Get all moves # Generate coverage report
const moves = await gamemasterClient.getMoves(); npm run test:coverage
// 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 2. **Option 2: Environment-based** - Create `.env` file (see Environment Setup section below) for CI/CD or shared development
### Environment Setup (Optional) ### Environment Setup (Optional)