Documentation repository for WebFiori framework. Any change to this repo in the main branch is reflected directly to the website at https://webfiori.com/docs.
This repo currently covers version 3.x of the framework.
- New to WebFiori? Start with Introduction
- Ready to install? Check Installation Guide
- Browse all topics: See Index
| Section | Topics |
|---|---|
| Getting Started | Introduction, Installation, Folder Structure, Basic Usage |
| Core Features | Routing, Response, Web Services, Middleware |
| UI Development | Web Pages, UI Package, Themes, i18n |
| Data & Storage | Database, Repository Pattern, Migrations, Sessions, Caching, JSON |
| File Handling | Uploading Files, Streaming Uploads, Resumable Uploads |
| Advanced | Background Tasks, Job Queue, Email, Event Dispatcher, DI, Security |
| Infrastructure | CLI, Health Checks, Logging, Environment Variables |
| Library | Docs |
|---|---|
webfiori/framework |
Routing, Middleware, Sessions, CLI commands |
webfiori/database |
Database, Repository, Migrations |
webfiori/http |
Web Services, MVC |
webfiori/file |
File Uploads (standard, streaming, resumable) |
webfiori/cli |
Command Line Interface |
webfiori/jsonx |
JSON handling |
webfiori/ui |
UI Package, Themes, Web Pages |
webfiori/mail |
Sending Emails |
See VERSIONING.md for the branching and versioning strategy.
Summary: main is always the current version. Old versions are frozen into branches (e.g., v3) only when work on the next major begins.
- Fork this repository
- Create a branch from
dev - Make your changes
- Submit a pull request to
dev
Guidelines:
- Use
> **Since X.Y**notes for features added in minor releases - Use
> **Deprecated since X.Y.**for deprecated features - Keep code examples minimal and runnable
- Verify class/method names against the actual library source
- Framework: WebFiori on GitHub
- Website: webfiori.com
- API Docs: webfiori.com/docs