zwitschi/rail-game
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: revert README structure

Browse Source
This commit is contained in:
zwitschi
2025-10-11 21:07:27 +02:00
parent 4393f17c45
commit 8877380f21
1 changed files with 105 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
README.md
View File

@@ -4,6 +4,56 @@ A browser-based railway simulation game using real world railway maps from OpenS
## Features ## Features
- Real world railway maps
- Interactive Leaflet map preview of the demo network snapshot
- Build and manage your own railway network
- Dynamic train schedules
## Architecture
The project is built using the following technologies:
- Frontend: HTML5, CSS3, JavaScript, React
- Backend: Python, FastAPI, Flask, SQLAlchemy
- Database: PostgreSQL with PostGIS extension
- Mapping: Leaflet, OpenStreetMap
## Project Structure
Planned structure for code and assets (folders created as needed):
```text
rail-game/
|-- backend/
| |-- app/
| | |-- api/ # FastAPI/Flask route handlers
| | |-- core/ # Config, startup, shared utilities
| | |-- models/ # SQLAlchemy models and schemas
| | |-- services/ # Domain logic and service layer
| | `-- websocket/ # Real-time communication handlers
| |-- tests/ # Backend unit and integration tests
| `-- requirements/ # Backend dependency lockfiles
|-- frontend/
| |-- public/ # Static assets served as-is
| |-- src/
| | |-- components/ # Reusable React components
| | |-- hooks/ # Custom React hooks
| | |-- pages/ # Top-level routed views
| | |-- state/ # Redux/Context stores and slices
| | |-- styles/ # Global and modular stylesheets
| | `-- utils/ # Frontend helpers and formatters
| `-- tests/ # Frontend unit and integration tests
|-- docs/ # Architecture docs, ADRs, guides
|-- infra/ # Deployment, IaC, Docker, CI workflows
|-- scripts/ # Tooling for setup, linting, migrations
|-- data/ # Seed data, fixtures, import/export tooling
`-- tests/ # End-to-end and cross-cutting tests
```
Use `infra/` to capture deployment assets (Dockerfiles, compose files, Terraform) and `.github/` for automation. Shared code that crosses layers should live in the respective service directories or dedicated packages under `backend/`.
## Installation
1. Clone the repository: 1. Clone the repository:
```bash ```bash
@@ -76,55 +126,66 @@ A browser-based railway simulation game using real world railway maps from OpenS
- Backend: `docker run -p 8000:8000 rail-game-backend` - Backend: `docker run -p 8000:8000 rail-game-backend`
- Frontend: Serve `frontend/dist` with any static file host. - Frontend: Serve `frontend/dist` with any static file host.
```bash
cd frontend cd frontend
npm install npm install
cd .. cd ..
```
```` 13. Build for production:
11. Build for production:
```bash ```bash
copy .env.example .env # PowerShell: Copy-Item .env.example .env copy .env.example .env
12. Run containers: ```
`DATABASE_URL`, `TEST_DATABASE_URL`, and `ALEMBIC_DATABASE_URL` control the runtime, test, and migration connections respectively. - PowerShell:
5. (Optional) Point Git to the bundled hooks: `pwsh scripts/setup_hooks.ps1`.
6. Run database migrations to set up the schema: ```pwsh
Copy-Item .env.example .env
```
14. Run containers:
- `DATABASE_URL`, `TEST_DATABASE_URL`, and `ALEMBIC_DATABASE_URL` control the runtime, test, and migration connections respectively.
15. (Optional) Point Git to the bundled hooks: `pwsh scripts/setup_hooks.ps1`.
16. Run database migrations to set up the schema:
```bash ```bash
cd backend cd backend
alembic upgrade head alembic upgrade head
cd .. cd ..
```` ```
7. Refresh OpenStreetMap fixtures (stations + tracks) into the local database: 17. Refresh OpenStreetMap fixtures (stations + tracks) into the local database:
```bash ```bash
python -m backend.scripts.osm_refresh --region all python -m backend.scripts.osm_refresh --region all
``` ```
Use `--no-commit` to dry-run the loader against existing data, or skip specific steps with the `--skip-*` flags. - Use `--no-commit` to dry-run the loader against existing data, or skip specific steps with the `--skip-*` flags.
8. Start the development servers from separate terminals: 18. Start the development servers from separate terminals:
- Backend: `uvicorn backend.app.main:app --reload --port 8000` - Backend: `uvicorn backend.app.main:app --reload --port 8000`
- Frontend: `cd frontend && npm run dev` - Frontend: `cd frontend && npm run dev`
9. Open your browser: frontend runs at `http://localhost:5173`, backend API at `http://localhost:8000`. 19. Open your browser: frontend runs at `http://localhost:5173`, backend API at `http://localhost:8000`.
10. Run quality checks: 20. Run quality checks:
- Backend unit tests: `pytest` - Backend unit tests: `pytest`
- Backend formatters: `black backend/` and `isort backend/` - Backend formatters: `black backend/` and `isort backend/`
- Frontend lint: `cd frontend && npm run lint` - Frontend lint: `cd frontend && npm run lint`
- Frontend type/build check: `cd frontend && npm run build` - Frontend type/build check: `cd frontend && npm run build`
11. Build for production: 21. Build for production:
- Frontend bundle: `cd frontend && npm run build` - Frontend bundle: `cd frontend && npm run build`
- Backend container: `docker build -t rail-game-backend backend/` - Backend container: `docker build -t rail-game-backend backend/`
12. Run containers: 22. Run containers:
- Backend: `docker run -p 8000:8000 rail-game-backend` - Backend: `docker run -p 8000:8000 rail-game-backend`
- Frontend: Serve `frontend/dist` with any static file host. - Frontend: Serve `frontend/dist` with any static file host.