Utopia is a website generation framework which provides a robust set of tools to build highly complex dynamic websites. It uses the filesystem heavily for content and provides functions for interacting with files and directories as structure representing the website.
Features
- Designed for both content-based websites and applications. Does not depend on a database.
- Supports flexible content localization based on industry recommendations.
- Rack middleware compatible with all major Ruby application servers. Small memory footprint by default.
- Low latency and high throughput. Capable of 10,000+ requests/second out of the box.
Usage
Please browse the source code index or refer to the guides below.
Getting Started
This guide explains how to set up a utopia website for local development and deployment.
Middleware
This guide gives an overview of the different Rack middleware used by Utopia.
Server Setup
This guide explains how to deploy a utopia web application.
Installing JavaScript Libraries
Utopia integrates with Yarn and provides a bake task to simplify deployment packages distributed using yarn that implement the dist sub-directory convention.
What is XNode?
This guide explains the xnode view layer and how it can be used to build efficient websites.
Updating Utopia
This guide explains how to update existing utopia websites.
See Also
- XRB — Template and markup parsers, markup generation.
- Utopia::Gallery — A fast photo gallery based on libvips.
- Utopia::Project — A Ruby project documentation tool.
- Utopia::Analytics — Simple integration with Google Analytics.
- HTTP::Accept — RFC compliant header parser.
- Samovar — Command line parser used by Utopia.
- Mapping — Provide structured conversions for web interfaces.
- Rack::Test::Body — Provide convenient helpers for testing web interfaces.
Examples
- Financier — A small business management platform.
- mail.oriontransfer.net - Mail server account management.
- www.codeotaku.com (source) — Personal website, blog.
Contributing
We welcome contributions to this project.
- Fork it.
- Create your feature branch (
git checkout -b my-new-feature). - Commit your changes (
git commit -am 'Add some feature'). - Push to the branch (
git push origin my-new-feature). - Create new Pull Request.
Developer Certificate of Origin
In order to protect users of this project, we require all contributors to comply with the Developer Certificate of Origin. This ensures that all contributions are properly licensed and attributed.
Community Guidelines
This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.