Report a Bug · Request a Feature · Ask a Question
Table of Contents
WebUI is a library for generating Web User Interfaces in a simple, type-safe, and consistent manner. It is inspired by modern web development practices and aims to provide a seamless experience for developers building static sites or dynamic web applications.
To use WebUI, ensure you have the following installed:
- Swift 6.1 or later
curl -fSls https://raw.githubusercontent.com/maclong9/web-ui/refs/heads/main/initialize.sh | shAdd the following to your package dependencies:
dependencies: [
.package(url: "https://github.com/maclong9/web-ui.git", from: "1.0.0")
],And then add this to your Target:
.executableTarget(
name: "Application",
dependencies: [
.product(name: "WebUI", package: "web-ui")
],
path: "Sources",
resources: [.process("Public")]
)Comprehensive API documentation is available on the GitHub Pages.
- Getting Started with WebUI
- Creating a Static Site
- Portfolio Example - A personal portfolio website built with WebUI
WebUI follows a structured development process with automated workflows to ensure code quality and consistency across releases.
For detailed information about contributing to WebUI, please refer to our CONTRIBUTING.md file, which includes:
- Branch structure and workflow
- Versioning system
- Release process
- Hotfix procedures
- Testing guidelines
- Documentation generation
- Code style guidelines
- Version bumps are triggered by commit prefixes:
feat!:(major),feat:(minor), andfix:(patch) - For hotfixes, use
fix!:in the commit message to trigger automatic PRs to all branches - Run tests locally with
swift test - Generate documentation with
swift package generate-documentation --target WebUI
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.
Please see our CONTRIBUTING.md document for detailed guidelines on how to contribute to this project. All contributors are expected to adhere to our Code of Conduct.
Reach out to the maintainer at one of the following places:
- GitHub discussions
- The email located in the GitHub profile
This project is licensed under the Apache 2.0 license. See LICENSE for more information.
Thanks to the following resources that inspired WebUI: