Altair is a Sass- and Grunt-based front-end starter kit, built on top of file-based CMS Kirby.
Kirby is a file-based CMS, meaning no database is involved for storing (and retrieving) content. All content is stored in plain text files (located in the /content
folder). For more information about Kirby CMS go here: http://getkirby.com.
The Kirby Panel is not (yet) a part of Altair, but can easily be added.
Altair (or for that matter Kirby) does not require a database, which makes it pretty straightforward to install.
Altair runs on PHP 5.3+, Apache or Nginx.
- Node.js
- Grunt
If you are familiar with Git, clone Altair’s repository from Github.
git clone --recursive https://github.com/studiodumbar/altair.git
The --recursive
flag is necessary to initiate and pull the kirby and toolkit submodules.
- Make sure that all folders and files within content are writable
- Make sure the thumbs folder is writable
- Rename both site/config/config.local.altair.php and site/config/config.altair.studiodumbar.com.php to reflect your own local and staging environments URL’s.
- Make sure to update and/or check in site/config/config.php the following config variables:
c::set('license', 'your license key');
c::set('resrc', true);
c::set('twitter.key', 'your api key');
c::set('twitter.secret', 'your api secret');
c::set('analytics.tool', 'ga-universal');
c::set('google.analytics.id', 'TRACKING ID IS NOT SET');
To run Altair locally, assets have to be generated:
-
In command:
sudo npm install
-
To generate dev assets and starting watch task:
grunt develop
or justgrunt
-
Other configured grunt tasks:
grunt styles
— generate dev styles onlygrunt scripts
— generate dev scripts onlygrunt criticalcss
— generate criticalCSS onlygrunt icons
— generate grunticon icon images (svg + png fallback) onlygrunt imageoptim
— optimize all jpg’s and png’s in content folder only
-
To deploy to staging and/or production environment:
grunt build
(version number is bumped from 0.0.2 to 0.0.3 and minified assets are generated) -
To bump version number from 0.0.x to 0.1.0:
grunt release
Jonathan van Wunnik (Studio Dumbar)
Marijn Tijhuis (Fat Pixel Studio)