jetzig/README.md
Bob Farrell 216b86c235 JSON and query param parsing/SSG params
Implement `jetzig.http.Request.params()` which parses either a JSON
request body or a query param string into a `jetzig.data.Value`.

Allow configuring params for static site generation - configure an array
of params for each endpoint which is then parsed at build time and a
separate JSON and HTML output is generated for each by invoking the
relevant view function and passing in resource ID/params. Params are
stored in generated `routes.zig` for route matching at run time.
2024-02-25 09:25:00 +00:00

56 lines
2.1 KiB
Markdown

![Jetzig Logo](demo/public/jetzig.png)
_Jetzig_ is a web framework written in [Zig](https://ziglang.org) :lizard:.
The framework is under active development and is currently in an alpha state.
Official website: [jetzig.dev](https://www.jetzig.dev/)
_Jetzig_ aims to provide a rich set of user-friendly tools for building modern web applications quickly. See the checklist below.
Join us on Discord ! [https://discord.gg/eufqssz7X6](https://discord.gg/eufqssz7X6).
If you are interested in _Jetzig_ you will probably find these tools interesting too:
* [Zap](https://github.com/zigzap/zap)
* [http.zig](https://github.com/karlseguin/http.zig)
* [zig-router](https://github.com/Cloudef/zig-router)
* [zig-webui](https://github.com/webui-dev/zig-webui/)
## Checklist
* :white_check_mark: File system-based routing with [slug] matching.
* :white_check_mark: _HTML_ and _JSON_ response (inferred from extension and/or `Accept` header).
* :white_check_mark: _JSON_-compatible response data builder.
* :white_check_mark: _HTML_ templating (see [Zmpl](https://github.com/jetzig-framework/zmpl)).
* :white_check_mark: Per-request arena allocator.
* :white_check_mark: Sessions.
* :white_check_mark: Cookies.
* :white_check_mark: Error handling.
* :white_check_mark: Static content from /public directory.
* :white_check_mark: Headers (available but not yet wrapped).
* :white_check_mark: Stack trace output on error.
* :white_check_mark: Static content generation.
* :x: Param/JSON payload parsing/abstracting.
* :x: Static content paramater definitions.
* :x: Environment configurations (develompent/production/etc.)
* :x: Middleware extensions (for e.g. authentication).
* :x: Email delivery.
* :x: Custom/non-conventional routes.
* :x: General-purpose cache.
* :x: Background jobs.
* :x: Testing helpers for testing HTTP requests/responses.
* :x: Development server auto-reload.
* :x: Database integration.
* :x: Email receipt (via SendGrid/AWS SES/etc.)
## LICENSE
[MIT](LICENSE)
## Contributors
* [Zackary Housend](https://github.com/z1fire)
* [Andreas Stührk](https://github.com/Trundle)
* [Bob Farrell](https://github.com/bobf)