tools/teletypegames
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rewrite READMEs in English for the WarpEngine split

Browse Source 
- root README: monorepo layout with libs/, the WarpEngine/host layering,
  rebuild note for the root build context, make api-test and snapshot docs
- warp_engine README translated to English

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
mr.zero
2026-08-04 19:36:40 +02:00
co-authored by Claude Fable 5
parent 4d1e04afdf
commit 516f724f01
2 changed files with 92 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+49 -19
View File
@@ -1,50 +1,80 @@
# Teletype Games
Monorepo: Vue 3 frontend + Rails 8 API.
Monorepo for the Teletype Games portal: a Vue 3 frontend, a Rails 8 API host app,
and the reusable **WarpEngine** software-catalog engine.
## Projekt struktúra
## Project structure
```
apps/
frontend/ # Vue 3 + Vite + TypeScript + Tailwind
api/ # Rails 8 API + ActiveAdmin
frontend/ # Vue 3 + Vite + TypeScript + Tailwind SPA
api/ # Rails 8 host app: TTG-specific API + ActiveAdmin shell
libs/
ruby/warp_engine/ # WarpEngine: mountable Rails engine (catalog, updater, admin resources)
```
## Fejlesztői környezet
The API is split in two layers:
- **WarpEngine** (`libs/ruby/warp_engine`) owns the software catalog: models
(softwares, releases, release assets, images, platform links, download stats),
the CI-callable `/update` endpoint, the public read-only JSON API
(`/api/software*`, `/api/builds*`, `/api/image`, `/api/download`, `/file/*`)
and the catalog ActiveAdmin resources. See its [README](libs/ruby/warp_engine/README.md).
- **The host app** (`apps/api`) owns everything TTG-specific: members, events,
wiki proxy, RSS feeds, Devise/ActiveAdmin authentication, theming and assets.
It consumes WarpEngine as a path gem and mounts it at `/`.
## Development environment
```bash
docker compose up -d
```
| Szolgáltatás | URL |
| Service | URL |
|---|---|
| Frontend | `http://${WEBAPP_DOMAIN}` |
| API | `http://${WEBAPP_DOMAIN}/api` |
| Admin | `http://${WEBAPP_DOMAIN}/admin` |
| API Docs | `http://${WEBAPP_DOMAIN}/api/swagger` |
| API docs | `http://${WEBAPP_DOMAIN}/api/swagger` |
The api image is built from the repo root (so the `libs/` path gems are visible
during `bundle install`) and mounts `./libs` at runtime. After changing the
compose file or the Gemfile, rebuild with `docker compose up -d --build api`.
## Testing
```bash
make api-test
```
Runs the host suite (`apps/api`, `softwares_test` DB), the WarpEngine suite
(dummy app, `warp_engine_test` DB) and a production-mode `zeitwerk:check`.
Individually:
```bash
docker exec -e RAILS_ENV=test api bundle exec rspec # host
docker exec -w /libs/ruby/warp_engine -e RAILS_ENV=test api bundle exec rspec # engine
```
JSON contract baselines for `/api/software` and `/api/builds` live in
`apps/api/spec/snapshots/` — diff against them after refactors.
## Linting
### Backend (RuboCop)
```bash
# Ellenőrzés
docker compose run --rm --no-deps api bundle exec rubocop
# Automatikus javítás
docker compose run --rm --no-deps api bundle exec rubocop -A
docker compose run --rm --no-deps api bundle exec rubocop # check
docker compose run --rm --no-deps api bundle exec rubocop -A # autofix
```
Konfig: `apps/api/.rubocop.yml` (rubocop-rails-omakase preset)
Config: `apps/api/.rubocop.yml` (rubocop-rails-omakase preset)
### Frontend (ESLint)
```bash
# Ellenőrzés
docker compose run --rm --no-deps frontend npm run lint
# Automatikus javítás
docker compose run --rm --no-deps frontend npm run lint:fix
docker compose run --rm --no-deps frontend npm run lint # check
docker compose run --rm --no-deps frontend npm run lint:fix # autofix
```
Konfig: `apps/frontend/eslint.config.js` (ESLint 9 flat config, Vue + TypeScript)
Config: `apps/frontend/eslint.config.js` (ESLint 9 flat config, Vue + TypeScript)