README.md

Unreal ORM Monorepo

Welcome to the Unreal ORM monorepo! This repository contains the source code for the Unreal ORM for SurrealDB, as well as documentation and supporting tools.

Looking for the ORM package? See packages/unreal-orm/README.md for detailed usage, API, and design docs for the ORM itself.

This repository is organized as a monorepo, making it easy to develop, test, and document the ORM in one place.

---

Repository Structure

/unreal-orm
├── apps/
│   └── docs/           # Documentation site (Astro)
├── packages/
│   ├── unreal-orm/     # The ORM library source code
│   └── unreal-cli/     # CLI tools for schema management
├── CONTRIBUTING.md     # How to contribute
└── ...

---

Documentation

• UnrealORM Documentation Site: Full docs, guides, and API reference

• Getting Started: Quickstart, installation, and onboarding

• Capabilities: Supported SurrealDB features

• Design Principles: Project philosophy and technical decisions

• Contributing Guide: How to contribute, code style, and submitting issues/PRs

• API Reference: Full API documentation

• Using Unreal ORM with AI: How to leverage LLMs with the ORM

• AI Friendly: Includes llms.txt and llms-full.txt for AI-powered development.

• Main ORM package: See packages/unreal-orm/README.md for usage, API, and details.

• CLI tools: See packages/unreal-cli/README.md for schema introspection (pull), migrations (push), diffing (diff), ERD generation (mermaid), and record browsing (view).

• Need help? Run unreal docs or unreal github.

• Documentation site source: See apps/docs/ for the Astro-powered docs.

---

License

This project is ISC licensed. See packages/unreal-orm/LICENSE for full details.