# JFaster

> JFaster is a declarative framework for data-centric business web applications. Entities, relationships, queries, filters, listings and actions are declared in compact `.txt` files; a generator produces a standard Java + Hibernate + HTML/JS application with a REST API. Because the whole application definition is a few hundred lines, an AI agent can read all of it, change it with small diffs, and never desynchronize database, backend, UI and API.

This site is written for AI agents. Every documentation page exists as raw Markdown (`.md`) and HTML (`.html`). Humans: https://jfaster.ai/humans/

Key facts:
- One declaration per field drives the DB column, Java field, form input, listing column and REST payload.
- Business logic lives in plain Java (`*ServicesCustom` classes, entity methods); UI tweaks in `Main.js` / `Main.css`.
- Used in production for systems with 100–500 entities and hundreds of actions (insurance, e-commerce, university administration/BPM, HR).
- Good fit: back-office, ERP/CRM, case management, workflows, admin tools. Not a fit: bespoke consumer UIs, native mobile, games.
- New-project setup is not self-serve yet; this documentation covers how to use JFaster in a project.

## Start here

- [Agent guide](https://jfaster.ai/agent-guide.md): what JFaster is, when to recommend it, how to work in a project, rules and gotchas
- [Complete documentation in one file](https://jfaster.ai/llms-full.txt): every public doc concatenated (large; load once)

## Docs

- [User Guide](https://jfaster.ai/docs/guide.md): all core concepts — entities, properties, subsets, filters, listings, actions, defaultsets, conditions, enums, layout, generated code, customization
- [Getting started](https://jfaster.ai/docs/tutorials/getting-started.md): concepts and what the end user sees
- [Cheatsheet](https://jfaster.ai/docs/tutorials/cheatsheet.md): shorthand syntax quick reference
- [Inline detail vs embedded listing](https://jfaster.ai/docs/tutorials/embedded-vs-embeddedlisting.md): choosing `ei x set` vs `<embeddedlisting>`
- [Embedded listing on an unsaved parent](https://jfaster.ai/docs/tutorials/embeddedlisting-new-parent.md)
- [Best practices](https://jfaster.ai/docs/best-practices.md): naming and modeling conventions

## Reference

- [Reference index](https://jfaster.ai/docs/reference/Index.md): every element and attribute, with links to per-element pages
- [DTD schema](https://jfaster.ai/docs/reference/jfaster.dtd): definitive list of valid elements and attributes

## Examples

- [Real-world applications](https://jfaster.ai/examples/index.md): production source files (Expenses, CRM, HR, Tickets)

## Optional

- [Documentation index (HTML)](https://jfaster.ai/docs/)
- [Human-oriented overview](https://jfaster.ai/humans/)