Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

What is Romanesco?

Romanesco is a collection of tools for prototyping and building websites. It integrates a front-end pattern library directly into a CMS (MODX Revolution).

It aims to combine various best practices like code reusability, iterative development, a content-first approach and modular, responsive content editing into one coherent ecosystem.

For more information, visit: https://romanesco.info/

Project structure

Romanesco is spread out across a few repositories:

  • Romanesco Soil (this repository)
    A pre-configured MODX installation, as starting point for your project.
  • Romanesco Patterns (only for development)
    A pattern library to manage all reusable elements from a central repository.
  • Romanesco Backyard
    A MODX package that fuses a few things together internally.
  • Romanesco Data
    A Gitify extract for updating Soil and Pattern data per project.
  • Romanesco Theme
    A custom styling theme for Fomantic UI1, the front-end framework used.
  • Romanesco Seed
    A command line installer, to preserve our sanity.

The elements in the pattern library are (loosely) structured according to the atomic design principles, as first outlined by Brad Frost. If you're not familiar with this concept, I suggest you read up on that first. It's incredibly useful.

Romanesco differs from the original PatternLab in 2 distinct ways:

This means that when you are done installing Romanesco, you have a working website. With CMS and decent styling.

The only thing you need in order to publish your site is fresh content. Well no, that's not entirely true:

Paid software alert

If you want to publish your project to a live domain, you'll need a license for ContentBlocks and Redactor. These are commercial extras for MODX, developed and maintained by ModMore.

ContentBlocks adds an intuitive and flexible drag&drop interface between MODX and the actual HTML of the page, making it a lot easier to manage responsive content. In fact, I wouldn't even bother building websites anymore without ContentBlocks, so I consider it an essential part of Romanesco.

Redactor is the rich text editor that's available inside the blocks and all throughout MODX. In theory, you could replace this by a free editor like TinyMCE, but Redactor has proven to be a rock solid product over the past many years. ModMore support is also top-notch, so I have no issues paying for it.

A single ContentBlocks license is €79 and for Redactor, that's €25. The people at ModMore are very considerate: you can try their extras for free during development.

So: publishing your project will require you to purchase a license, but getting started with Romanesco is still free at this point. If you're OK with that, then let's move on!

Installation

Romanesco is not exactly a plug and play environment. Many moving parts means it requires a fair bit of configuration (and patience) to get everything up and running.

Luckily, there's now a command line installer available that automates a large portion of this process. Learn how to get started here.

For the persistent and the brave: you can also install everything manually.

Demo

To get an idea of what's included in this library and what you can do with it, visit https://romanesco.info. Everything you see there is created with Romanesco. You can also view the pattern library, which is automatically generated from the available components.

Yes, but... What is a Romanesco?

The real romanesco is a curious crossover between a broccoli and a cauliflower. Its flowers are shaped by self-repeating mathematical patterns, forming a mesmerizing collection of green fractals, spiraling up and multiplying in perfect resonance with Fibonacci's golden ratio. The result is a vegetable that looks almost too stunning to be eaten!

To me, that perfectly symbolizes my intention with this platform: to create something reusable based on common patterns, without sacrificing aesthetics and uniqueness.

Fractal Broccoli

1 Romanesco switched to Fomantic UI, a community fork of the Semantic UI project.

About

Romanesco is an ecosystem for building websites with reusable components.

Resources

License

Stars

Watchers

Forks

Packages

No packages published