Fractality

Fractality is a tool to help you build and document website component libraries and design systems.

Read the full Fractality documentation

Fork

Fractality is a fork of the popular Fractal-Project.

Introduction

Component (or pattern) libraries are a way of designing and building websites in a modular fashion, breaking up the UI into small, reusable chunks that can then later be assembled in a variety of ways to build anything from larger components right up to whole pages.

Fractality helps you assemble, preview and document website component libraries, or even scale up to document entire design systems for your organisation.

Check out the documentation for more information.

Requirements

You'll need a supported LTS version of Node. Fractality may work on unsupported versions, but there is no active support from Fractality and new features may not be backwards compatible with EOL versions of Node.

Getting started

Install into your project (recommended)

npm install @fractality/fractality --save-dev

Then create your fractality.config.js file in the project root, and configure using the official documentation.

Then you can either run npx fractality start to start up the project, or create an alias under the scripts section in your package.json as a shortcut.

e.g.

"scripts": {
    "fractality:start": "fractality start --sync",
    "fractality:build": "fractality build"
}

then

npm run fractality:start

Installing globally

npm i -g @fractality/fractality

This will also give you global access to the fractality command which you can use to scaffold a new Fractality project with fractality new.

The downside is that it's then difficult to use different Fractality versions on different projects.

This option is not recommended until a global Fractality install is capable of offloading to a project specific version.

Examples

• Official demo (using Nunjucks): demo.fractal.build

  Repository: demo.fractal.build

• Official examples are available in the examples directory. Although we primarily use them for developing and testing Fractal, they probably are a great resource for users as well.

• Additional public examples can be found on the Awesome Fractal repo.

Contributing

Please note we have a code of conduct, please follow it in all your interactions with the project.

Reporting issues & requesting features

We use GitHub issues to track bugs and feature requests. Thank your for taking the time to submit your issue to sitepark/fractality.

Submitting pull requests

Please submit PRs against main branch with an explanation of your intention.

We use conventional commits, which means that every pull request title should conform to the standard.

Development

This repository is a monorepo managed by Lerna. There is only one lockfile in root. This means that all packages must be installed in root, manually added to the packages' package.json files and then bootstrapped with lerna.

To do some work, run the following commands in root:

1. npm ci
2. npm run bootstrap

Testing

Fractality is a project that evolved rapidly and organically from a proof-of-concept prototype into a more stable, mature tool. Because of this it's currently pretty far behind where it should be in terms of test coverage. Any contributions on this front would be most welcome!

Existing tests can be run using the npm test command.

Contributors ✨

Thanks goes to all wonderful people who have helped us out.

Contributions of any kind welcome!

License

MIT