Skip to content
/ fractal Public

A tool to help you build and document website component libraries and design systems.

License

Notifications You must be signed in to change notification settings

frctl/fractal

 
 

Repository files navigation

Fractal

A toolkit for working with filesystem-based component libraries.


This branch is for development of the work-in-progress Fractal version 2.0 release. Feel free to play around with it but be warned that breaking changes are likely to happen until we get to a stable release candidate 🚀


Build Status Coverage Status NPM Version

Current status (v2.0)

A prototype build of Fractal v2.0, put together as a proof-of-concept, has been up and running for a little while now and has allowed us to explore a few options for the best way to implement some of the features and improvements discussed in Moving Fractal forwards. We are now ready to move public development into this frctl/v2 branch to clean up the prototype code and work towards getting a proper beta release out. To this end we will now start migrating existing prototype code into this branch bit by bit, cleaning it up and adding tests as we go.

As soon as we have a beta release candidate together we will be soliciting feedback from anyone who feels brave enough to have a play with it :-)

Development and contributing

We are moving development of Fractal v2.0 and all first-party add-ons into a 'monorepo' format, using Lerna to help manage linking and publishing individual packages within the monorepo.

Running locally

  1. Clone this repository
  2. Install dependencies - npm install
  3. Bootstrap the packages together using Lerna - npm run bootstrap

Tests

Code is linted via xo/eslint using the Fractal eslint config, and tests are written using Mocha & Chai.

Test can be run with npm test. There are also NPM package scripts available for running subsets of the tests if required.

Requirements

Fractal requires Node.js v7.6.0 or greater.

Credits

Fractal is developed and maintained by Danielle Huntrods, Mark Perkins and all our other excellent contributors.

Ongoing support by Clearleft makes this project possible. Thank you!