Skip to content

wimpysworld/wagall

Repository files navigation

Wagall

GCSE revision companion - an AI-powered marking and feedback tool built with Wails 3 and Svelte 5.

Currently an MLP (minimum loveable product) with three subject rooms and canned dummy responses. Claude integration coming soon.

Prerequisites

  • Go 1.24+
  • Node.js 20+ (with npm)
  • Wails 3 CLI
  • A C compiler (gcc or clang) for CGo
  • WebKit2GTK development libraries (e.g. libwebkit2gtk-4.1-dev on Debian/Ubuntu)

Getting Started

# Clone the repository
git clone https://github.com/wimpysworld/wagall.git
cd wagall

# Install Go dependencies
go mod tidy

# Install frontend dependencies
cd frontend && npm install && cd ..

# Run in development mode (hot-reload for frontend, auto-rebuild for Go)
wails3 dev

Building

# Debug build
wails3 build

# Run the built binary
./bin/wagall

Project Structure

wagall/
├── main.go              # Wails application entry point
├── chat_service.go      # Go service exposed to the frontend
├── build/               # Build configuration and platform tasks
│   ├── config.yml       # Wails dev mode and project config
│   ├── Taskfile.yml     # Common build tasks
│   └── linux/           # Linux-specific build tasks
├── frontend/            # Svelte 5 frontend
│   ├── src/
│   │   ├── App.svelte   # Root component with room state
│   │   └── lib/         # UI components
│   ├── index.html
│   ├── package.json
│   └── vite.config.js
├── Taskfile.yml         # Root task orchestration
└── go.mod

Subject Rooms

Room Exam Board Specification
English Language AQA 8700
English Literature AQA 8702
History Eduqas C100

Licence

TBD

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors