Skip to main content

Getting Started

Installation

Add Toucaan to your project, like so:

in/your/project/at/root/
git submodule add https://github.com/Toucaan/toucaan

The command above will add Toucaan to your project like a git submodule. Please commit the .gitmodules file to your repository along with the framework code.

Now you can start implementing your app's multiple frontends with Toucaan.

Go to the next step and set up the sass preprocessor.

tip

Review the Architecture of Toucaan? Glance through the core concepts quickly!

Inline Documentation

Toucaan's sourcecode is also documented in-line. Contributions and improvements are very welcome.

caution

This is an early version of Toucaan (< 1.0.0). Our documentation and tooling is in the state of flux and you're likely to encounter a few breaking changes in the next few weeks.