Skip to content

wjobin/zaik

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Zaik

A modern text-based adventure game inspired by Zork, powered by Large Language Models.

Overview

Zaik combines classic text adventure gameplay with AI-powered natural language understanding to create dynamic, immersive interactive fiction experiences.

Architecture

  • Frontend: React-based terminal interface
  • Backend: Python with FastAPI
  • Database: Document database (MongoDB/CouchDB)
  • LLM Integration: Custom server for AI-powered interactions

Project Structure

zaik/
├── backend/          # Python FastAPI server
├── frontend/         # React application
├── docs/            # Project documentation
└── CLAUDE.md        # Development instructions

Prerequisites

  • Docker - For running services and building deployments
  • mise - For local development (optional)
  • uv - Fast Python package management (optional, for local development)

Quick Start

Using Docker (Recommended)

Start the entire game stack (frontend + backend) with one command:

# Start all services in development mode
docker compose up

# Or run in detached mode
docker compose up -d

Access the services:

Stop services:

docker compose down

Production Build

For production deployment:

# Build and run production containers
docker compose -f docker-compose.prod.yml up -d

Production URLs:

Local Development

For local development without Docker:

Backend:

cd backend
mise install
source venv/bin/activate
python -m uvicorn app.main:app --reload

Frontend:

cd frontend
npm install
npm run dev

See backend/README.md and frontend/README.md for detailed setup instructions.

Getting Started

See CLAUDE.md for detailed development instructions and workflow.

Development Status

This project is in early development. Check the Notion board for current progress and roadmap.

About

A modern text-based adventure game inspired by Zork, powered by Large Language Models

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors