fez

Fez is a Kemal application generator.

Setting up a Kemal app is super simple, but if the app you're building is a little more than "super simple", there's a bit of things you'll end up doing each time you start a project. Why not have a mini generator that will do it for you?

This initial version is going to make some heavy assumptions about the type of app you're building, and the organization of where things will go. Eventually it'll be nice to flesh that out, and make it configurable or something...

• This app will have views
• Views will use Slang
• Stylesheets will be Sass
• Javascript will use ES6 compiled from Babel

Installation

Since this is an application generator, there's no need to include it as a dependency, or shard. Just install it locally, and build the executable.

$ git clone git@github.com:jwoertink/fez.git
$ cd fez/
$ make

You should now have a bin/fez file to run. You can symlink this to a more global location like /usr/bin/local to make it easier to use.

Optionally, you can use homebrew to install.

brew tap jwoertink/fez
brew install fez

Usage

Using fez is pretty easy. To see a help menu just run fez -h. You can see the version of fez you're running with fez -v

TL;DR fez -b my_app -d projects

Specifying the directory

To set the directory where your app will be created, you run fez with the --directory or -d flag, and pass the directory location/name.

$ fez -d ~/Sites

or

$ fez --directory=~/Projects

If you don't specify a directory, fez will assume you want to use the /tmp directory.

Naming your app

To set the name of your application, you run fez with the --build or -b flag. This example will generate a /tmp/my_cool_app/ folder.

$ fez -b my_cool_app

or

$ fez --build=my_cool_app

Development

TODO: (in no particular order)

• [x] Generate basic project structure
• [x] Get a sample app to boot
• [x] Compile sass to css
• [x] Compile es6 to js
• [x] Generate sample spec for making a call to the home page
• [ ] Configuration for using less over sass
• [ ] Configuration for using coffeescript over es6
• [ ] Configuration for defaulting back to ecr instead of slang
• [ ] Use a crystal implementation for stylesheet compilation
• [ ] Use a crystal implementation for javascript compilation
• [x] Add in auto-reload for development

Generated structure

public/
  | stylesheets/
  | javascripts/
  | images/
  | favicon.ico
  | robots.txt
spec/
  | spec_helper.cr
  | app_name_spec.cr
src/
  | assets/
  | | styles/
  | | scripts/
  | macros/
  | | helper.cr
  | views/
  | | layouts/
  | | | layout.slang
  | | site/
  | | | index.slang
  | app_name.cr
.env
.gitignore
.travis.yml
Gemfile
Guardfile
Makefile
README.md
app.cr
es2js.rb
shard.yml

Philosophy

I would like this to be an easy way to knock out a bunch of kemal apps without having to go through and setup the same things over and over.

I don't want this to become a "framework" wrapper around kemal (even though my apps will most likely do that anyway). If you're looking for a full MVC framework, check out something like Amethyst or Kemalyst.

Contributing

1. Fork it ( https://github.com/jwoertink/fez/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• [jwoertink] Jeremy Woertink - creator, maintainer