Skip to content

CogitatorTech/helium

Helium Logo

Helium

Tests CodeFactor Zig Version Examples Docs Release License

A micro web framework for Zig


Helium is a small, configurable web framework for the Zig programming language. It aims to provide the essential building blocks needed for creating fast web applications and services in Zig without getting in the way of your application's logic.

Helium follows a micro-framework design philosophy with a small core feature set that can be extended via optional middleware and utilities. It aims to be lightweight and easy to use but still be able to provide the necessary building blocks for building complex web applications by allowing users to compose their applications from reusable components.

Features

  • Supports application type with custom context
  • Supports Type-safe request handlers and middleware
  • Supports configurable memory allocator and error handlers
  • Provides routing API with dynamic parameters and query parsing
  • Supports route groups with shared path prefixes
  • Provides middleware for global, group, and route-specific logic
  • Supports JSON and plain text response serialization
  • Supports static file serving with path traversal protection

See the ROADMAP.md for the full list of implemented and planned features.

Important

Helium is in early development, so bugs and breaking changes are expected. Please use the issues page to report bugs or request features.


Getting Started

To be added.


Documentation

Check out the docs directory for Helium documentation, including the API reference.

Examples

Check out the examples directory for example usages for various Helium features.


Contributing

See CONTRIBUTING.md for details on how to make a contribution.

License

Helium is licensed under the MIT License (see LICENSE).

Acknowledgements

  • The logo is from SVG Repo with some modifications.

About

A micro web framework for Zig (WIP)

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Contributors 2

  •  
  •