A frontend codebase for an RPG game manager focused on the roleplaying game Feng Shui 2. This project connects to @progressions/shot-server to provide a complete experience for managing player sheets, tracking scenes, and facilitating gameplay.
- Built with Next.js, offering fast, modern web interactions.
- Connects seamlessly to the Shot Server backend for real-time updates and data management.
- Optimized UI for Feng Shui 2, including support for custom sheets, scene tracking, and game-specific mechanics.
- Uses
next/fontfor font optimization (Geist). - Flexible development with support for npm, yarn, pnpm, and bun.
- Backend Server: Ensure the Shot Server (Rails API) is running on port 3000
- Environment Configuration: Create required environment files
Create a .env.local file in the project root with the following configuration:
# API Configuration
NEXT_PUBLIC_API_URL=http://localhost:3000
NEXT_PUBLIC_WS_URL=ws://localhost:3000/cable
# Development settings
NODE_ENV=developmentFor testing environments, also create a .env.test file:
# Test API Configuration
NEXT_PUBLIC_API_URL=http://localhost:3004
NEXT_PUBLIC_WS_URL=ws://localhost:3004/cable
# Test settings
NODE_ENV=test.env.local file is required for the application to connect to the backend API. Without it, authentication and data loading will fail.
First, install dependencies:
npm installThen run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun devOpen http://localhost:3001 with your browser to see the result.
You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.
src/: Main source code.public/: Static assets.plop-templates/: Code generation templates.DevelopingAutocomplete.md: Documentation for autocompletion development.- Configuration files for linting, formatting, TypeScript, and Next.js.
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - interactive tutorial.
- Shot Server - backend service for this client.
The easiest way to deploy your Next.js app is to use the Vercel Platform. See Next.js deployment documentation for more details.