https://github.com/socketry/utopia

A content-centric Ruby/Rack based web framework.
https://github.com/socketry/utopia

framework ruby utopia web

Last synced: 3 months ago
JSON representation

A content-centric Ruby/Rack based web framework.

• Host: GitHub
• URL: https://github.com/socketry/utopia
• Owner: socketry
• License: mit
• Created: 2010-04-17T15:04:59.000Z (over 14 years ago)
• Default Branch: main
• Last Pushed: 2024-07-05T09:23:51.000Z (4 months ago)
• Last Synced: 2024-07-05T15:52:40.127Z (4 months ago)
• Topics: framework, ruby, utopia, web
• Language: Ruby
• Homepage:
• Size: 2.52 MB
• Stars: 138
• Watchers: 8
• Forks: 18
• Open Issues: 6
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

README

        
# ![Utopia](materials/utopia.svg)

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](https://github.com/socketry/utopia/workflows/Test/badge.svg)](https://github.com/socketry/utopia/actions?workflow=Test)

## 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 see the [project documentation](https://socketry.github.io/utopia).

## See Also

  - [XRB](https://github.com/socketry/xrb) — Template and markup parsers, markup generation.

  - [Utopia::Gallery](https://github.com/ioquatix/utopia-gallery) — A fast photo gallery based on [libvips](https://github.com/jcupitt/libvips).

  - [Utopia::Project](https://github.com/socketry/utopia-project) — A Ruby project documentation tool.

  - [Utopia::Analytics](https://github.com/ioquatix/utopia-analytics) — Simple integration with Google Analytics.

  - [HTTP::Accept](https://github.com/ioquatix/http-accept) — RFC compliant header parser.

  - [Samovar](https://github.com/ioquatix/samovar) — Command line parser used by Utopia.

  - [Mapping](https://github.com/ioquatix/mapping) — Provide structured conversions for web interfaces.

  - [Rack::Test::Body](https://github.com/ioquatix/rack-test-body) — Provide convenient helpers for testing web interfaces.

### Examples

  - [Financier](https://github.com/ioquatix/financier) — A small business management platform.

  - [mail.oriontransfer.net](https://github.com/oriontransfer/mail.oriontransfer.net) - Mail server account management.

  - [www.codeotaku.com](http://www.codeotaku.com) ([source](https://github.com/ioquatix/www.codeotaku.com)) — Personal website, blog.

## 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

In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). 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.