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.
- 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.
Please browse the source code index or refer to the guides below.
This guide explains how to set up a
utopia website for local development and deployment.
This guide gives an overview of the different Rack middleware used by Utopia.
This guide explains how to deploy a
utopia web application.
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.
This guide explains how to update existing
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.
- Trenni — Template and markup parsers, markup generation.
- Trenni::Formatters — Helpers for HTML generation including views and forms.
- 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.
Released under the MIT license.
Copyright, 2009-2020, by Samuel G. D. Williams.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.