Kirby, twig and fractal—married into something nice.
Kalong is a collection/combination of different tools, to help you get started creating your own frontend styleguide, with easy reusable components. It is based on Fractal and a collection of custom npm-tasks to get you started fast.
Kalong is intended to be cloned, configured and setup as the core of your project, so instead of npm-installing this, you should rather clone this project:
git clone https://github.com/webgefrickel/kalong.git ./newprojectAfter successfully cloning kalong, run npm install in the folder you
cloned it into to install all needed dependencies.
Open the file kalong.config.js, change the title of to match your
project and bump the version-number, if you want to. If you have a local
server running (like Apache or nginx), you should create a subdomain and
point this vhost to the public-folder of the just created project. This
step is optional, but highly recommended.
Open up a terminal and run npm start and the development-server will
fire up, and you can start creating new components, templates and
whatever you want. Have a look at the folder src, there you will find
a fully working basic setup. There is more documentation available in
the styleguide itself, have a look at the running fractal-instance!
You have a new release of your styleguide ready? First, bump up the
version number in kalong.config.js. Then run npm run build to
create a production-ready version of the styleguide, with minified
JavaScript and CSS and everything you need.
Feel free to open issues and send me pull requests.
Steffen Rademacker @webgefrickel
kalong is published under the MIT License