branderson
2d1d8cce46
mirror/github-mirror.sh publishes main and its tags to a read-only GitHub mirror, adding a notice under the README title, with a systemd timer to run it hourly. A GitHub Actions workflow builds the images on the mirror and pushes them to ghcr.io. The docs point prebuilt images there, and CONTRIBUTING no longer invites issues and pull requests. upstream-status.sh now fetches without tags, so upstream's version tags stay out of local clones.
72 lines
2.5 KiB
Markdown
72 lines
2.5 KiB
Markdown
# Development Documentation
|
|
|
|
This directory contains comprehensive documentation for developers working on
|
|
the Dotcom Arcade application.
|
|
|
|
## Contents
|
|
|
|
1. **[Setup Guide](./setup-guide.md)** - Complete development environment setup
|
|
2. **[Commands Reference](./commands.md)** - All npm commands for monorepo and
|
|
services
|
|
3. **[Project Structure](./project-structure.md)** - Directory structure
|
|
explained
|
|
4. **[Coding Standards](./coding-standards.md)** - TypeScript conventions and
|
|
style guide
|
|
5. **[Testing Guide](./testing-guide.md)** - Testing approach and best practices
|
|
6. **[Debugging Guide](./debugging.md)** - Debugging tips and troubleshooting
|
|
7. **[Common Pitfalls](./common-pitfalls.md)** - Known issues and solutions
|
|
8. **[Upstream Sync](./upstream-sync.md)** - Merging changes from flashpoint-web
|
|
9. **[GitHub Mirror](./github-mirror.md)** - Publishing to GitHub and GHCR
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
# Install dependencies for all services
|
|
npm run install:all
|
|
|
|
# Start all services in development mode
|
|
npm run dev
|
|
|
|
# Run type checking across all services
|
|
npm run typecheck
|
|
|
|
# Build all services for production
|
|
npm run build
|
|
```
|
|
|
|
## Development Workflow
|
|
|
|
1. **Initial Setup**: Follow the [Setup Guide](./setup-guide.md)
|
|
2. **Learn Commands**: Review [Commands Reference](./commands.md)
|
|
3. **Understand Structure**: Read [Project Structure](./project-structure.md)
|
|
4. **Follow Standards**: Apply [Coding Standards](./coding-standards.md)
|
|
5. **Write Tests**: Use [Testing Guide](./testing-guide.md)
|
|
6. **Debug Issues**: Reference [Debugging Guide](./debugging.md)
|
|
7. **Avoid Pitfalls**: Check [Common Pitfalls](./common-pitfalls.md)
|
|
|
|
## Architecture Overview
|
|
|
|
The project is a monorepo with two independent services:
|
|
|
|
- **Backend** (port 3100): REST API with Express + TypeScript (includes game service)
|
|
- **Frontend** (port 5173): React SPA with Vite + TypeScript
|
|
|
|
Each service can be developed, tested, and deployed independently. The game service is now integrated into the backend as the `/game-proxy/*` and `/game-zip/*` routes.
|
|
|
|
## Getting Help
|
|
|
|
- Review existing documentation in this directory
|
|
- Check the main [CLAUDE.md](../../CLAUDE.md) for project overview
|
|
- Consult service-specific docs in `docs/03-backend` and `docs/04-frontend`
|
|
- Review architecture documentation in `docs/02-architecture`
|
|
|
|
## Contributing
|
|
|
|
When adding new features or fixing bugs:
|
|
|
|
1. Follow the coding standards outlined in this documentation
|
|
2. Write tests for new functionality
|
|
3. Update relevant documentation
|
|
4. Ensure all type checks pass (`npm run typecheck`)
|
|
5. Verify no build errors (`npm run build`)
|