> For the complete documentation index, see [llms.txt](https://dukefirehawk.gitbook.io/kelicap-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dukefirehawk.gitbook.io/kelicap-docs/readme.md).

# Kelicap Documentation

[![Kelicap Web Framework](https://2948821021-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcMTl3zCAx2gDZ0oSCmmq%2Fuploads%2Fgit-blob-f6625bc190102cdd190bade99caeb3522461d282%2Fkelicap_1_banner.jpeg?alt=media)](https://github.com/dukefirehawk/kelicap)

[![License: CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg)](https://github.com/dukefirehawk/kelicap-docs/tree/main/LICENSE/README.md)

Documentation, tutorial and user guides for the [Kelicap](https://github.com/dukefirehawk/kelicap) web framework.

Kelicap is a lightweight web framework for modern Dart (3.13+) that renders native HTML. It is a fork of AngularDart, uses [`package:web`](https://pub.dev/packages/web) for all DOM access, and keeps a syntax close to Angular's.

**Version:** 1.1.2

## 📖 Table of Contents

### [Tutorial: Tour of Heroes](/kelicap-docs/tutorial/tutorial.md)

Build a small app step by step, from a starter project to a routed app that talks to a server.

1. [The Starter App](/kelicap-docs/tutorial/tutorial/toh-pt0.md)
2. [The Hero Editor](/kelicap-docs/tutorial/tutorial/toh-pt1.md)
3. [Master/Detail](/kelicap-docs/tutorial/tutorial/toh-pt2.md)
4. [Multiple Components](/kelicap-docs/tutorial/tutorial/toh-pt3.md)
5. [Services](/kelicap-docs/tutorial/tutorial/toh-pt4.md)
6. [Routing](/kelicap-docs/tutorial/tutorial/toh-pt5.md)
7. [HTTP](/kelicap-docs/tutorial/tutorial/toh-pt6.md)

### [User Guide](/kelicap-docs/user-guide/user-guide.md)

How each part of the framework works, from installation and architecture to templates, dependency injection, forms, routing and testing.

### [Deployment Guide](/kelicap-docs/deployment-guide/deployment-guide.md)

How to build a Kelicap app for production and deploy it.

## Related projects

* [Kelicap](https://github.com/dukefirehawk/kelicap): the framework, published on pub.dev as [`kelicap`](https://pub.dev/packages/kelicap), [`kelicap_router`](https://pub.dev/packages/kelicap_router), [`kelicap_forms`](https://pub.dev/packages/kelicap_forms) and [`kelicap_test`](https://pub.dev/packages/kelicap_test)
* [Kelicap Components](https://github.com/dukefirehawk/kelicap_components): Material Design 2 components for Kelicap, published as [`kelicap_components`](https://pub.dev/packages/kelicap_components)

## Contributing

The docs are plain GitHub-flavored Markdown with no build step. Work on a topic branch and open a pull request against `main`. [AGENTS.md](https://github.com/dukefirehawk/kelicap-docs/tree/main/AGENTS.md) describes the layout, the Markdown format and the conventions for code samples. Record user-facing changes in [CHANGELOG.md](/kelicap-docs/project/changelog.md).

## License

This documentation is licensed under the [Creative Commons Attribution 4.0 International License](https://github.com/dukefirehawk/kelicap-docs/tree/main/LICENSE/README.md) (CC BY 4.0). Maintainers are listed in [AUTHORS.md](https://github.com/dukefirehawk/kelicap-docs/tree/main/AUTHORS.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://dukefirehawk.gitbook.io/kelicap-docs/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.