first release! 0.3.6
This commit is contained in:
34
README.md
34
README.md
@@ -4,6 +4,12 @@ A full-stack web application that helps groups pick games to play from various J
|
||||
|
||||
## Features
|
||||
|
||||
### Progressive Web App (PWA)
|
||||
- **Installable**: Add to home screen on mobile and desktop devices
|
||||
- **Offline Support**: Service worker provides offline functionality
|
||||
- **Native Experience**: Runs like a native app when installed
|
||||
- **Auto-updates**: Seamlessly updates to new versions
|
||||
|
||||
### Admin Features
|
||||
- **Game Picker**: Randomly select games with intelligent filters
|
||||
- Filter by player count, drawing games, game length, and family-friendly status
|
||||
@@ -130,6 +136,34 @@ The backend will run on http://localhost:5000
|
||||
|
||||
The frontend will run on http://localhost:3000 and proxy API requests to the backend.
|
||||
|
||||
## Configuration
|
||||
|
||||
### Branding and Metadata
|
||||
|
||||
All app branding, metadata, and PWA configuration is centralized in `frontend/src/config/branding.js`. Edit this file to customize:
|
||||
|
||||
- **App Name** and **Short Name** - Displayed in UI and when installed as PWA
|
||||
- **Description** - Shown in search engines and app stores
|
||||
- **Version** - Current app version
|
||||
- **Theme Color** - Primary color for browser chrome and PWA theme
|
||||
- **Keywords** - SEO metadata
|
||||
- **Author** - Creator/maintainer information
|
||||
- **Links** - GitHub repo, support contact, etc.
|
||||
|
||||
When you update `branding.js`, the following are automatically synchronized:
|
||||
|
||||
1. **PWA Manifest** (`manifest.json`) - Generated at build time via `generate-manifest.js`
|
||||
2. **HTML Meta Tags** - Updated via Vite HTML transformation plugin
|
||||
3. **App UI** - Components import branding directly
|
||||
|
||||
To regenerate the manifest manually:
|
||||
```bash
|
||||
cd frontend
|
||||
npm run generate-manifest
|
||||
```
|
||||
|
||||
The manifest is automatically generated during the build process, so you don't need to edit it directly.
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user