Skip to content

gardusig/yugioh

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Yu-Gi-Oh! Deck Editor

Java 21 Backend Coverage
React 18.2 Frontend Coverage
Python 3.9 Scripts Coverage

Full-stack app for browsing cards and building decks: Spring Boot API, PostgreSQL, React frontend, Python scripts for data. Everything runs with Docker (or Podman). You get card browsing with pagination, deck list and composition (40 cards), card details, and Swagger API docs; the DB can be reset, migrated, and seeded from CSV.

Setup: For what to install (Docker, Podman, macOS/Homebrew, etc.), see Setup guide.


Quick start

  1. Prereqs: Docker + Compose — see Setup guide for install steps.

  2. Run (from repo root):

    docker compose up --build
  3. Open:

    Service URL
    Frontend http://localhost:8082
    Swagger UI http://localhost:8080/swagger-ui.html
    Health http://localhost:8080/healthcheck

    First run runs migrations and seeds the DB from CSV automatically.

  4. Tests (no DB): docker compose --profile test build — see Tests for per-project commands and Podman.


Run & links

Service URL Description
Frontend http://localhost:8082 Cards grid, decks list; click a card for details, a deck for composition.
Swagger UI http://localhost:8080/swagger-ui.html Interactive API docs; try GET /cards, GET /decks.
Health http://localhost:8080/healthcheck Backend health check.

Per-project

Project Dockerfile README
Backend backend/Dockerfile backend/README.md
Frontend frontend/Dockerfile frontend/README.md
Scripts scripts/Dockerfile (stages: test, default; build from repo root) scripts/README.md

Documentation

When you want to… Doc
Get running — setup, run app (Docker/Podman) SETUP_AND_TESTS
Run tests — per-project, Podman, native, CI TESTS
Use the app — URLs, Swagger, frontend usage GETTING_STARTED
Work on code — backend/frontend locally (no containers) DEVELOPMENT
Database — reset, migrate, seed, check data DATABASE_MAINTENANCE
Schema — migrations, adding tables DATABASE_MIGRATIONS
API — endpoints, examples API_ENDPOINTS
Layout — repo structure PROJECT_STRUCTURE
Problems — common errors and fixes TROUBLESHOOTING
Stack — technologies and tools TECHNOLOGY_STACK
License LICENSE

Website preview

Screenshots in docs/screenshots/:

Page Preview
Cards Cards page
Card detail Card detail
Decks list Decks list
Deck composition Deck composition

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors