SUPER EXPERIMENTAL, BREAKING CHANGES TO COME IN 1.0 RELEASE
Looking for the Trailpack? Visit https://github.com/CaliStyle/trailpack-treefrog.
Looking for the Generator? Visit https://github.com/CaliStyle/generator-treefrog.
You'll need the following software installed to get started tinkering with Treefrog.
The Sass components are available on npm.
$ npm install treefrog --save
While working on your project, run:
$ npm start
Building this Repo
If you want to work with the source code directly or compile our documentation, follow these steps:
git clone https://github.com/CaliStyle/treefrog.git cd treefrog npm install
While you're working on the code, run:
$ npm start
The documentation can be viewed at the same URL as above.
build: This is where our documentation is assembled. Don't edit these files directly, as they're overwritten every time you make a change!
docs: The Treefrog documentation.
scss: The Sass components.
dist: Compiled CSS files, in minified and unmified flavors.
tests: Unit tests.
Treefrog follows semver, so we won't introduce breaking changes in minor or patch versions. The
master branch will always have the newest changes, so it's not necessarily production ready. The
stable branch will always have the most recent stable version of the framework.
We love contributions!
For Treefrog please check out our Contributor's Guide for more information on how our projects are organized and how to get started.
For Trails please check out our Contributor's Guide for more information on how our projects are organized and how to get started.
If you find a problem or have an idea, open a new issue on GitHub. When filing a bug report, make sure you specify the browser and operating system you're on, and toss us a screenshot or show us how we can recreate the issue.