Utopia

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.

Development Status

Features

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

Examples

Contributing

We welcome contributions to this project.

  1. Fork it.
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin my-new-feature).
  5. Create new Pull Request.

Developer Certificate of Origin

This project uses the Developer Certificate of Origin. All contributors to this project must agree to this document to have their contributions accepted.

Contributor Covenant

This project is governed by the Contributor Covenant. All contributors and participants agree to abide by its terms.