Home Page

A full-featured Crystal web framework that catches bugs for you, runs incredibly fast, and helps you write code that lasts.

https://luckyframework.org

1. Installation

On MacOS - use:

$ brew install openssl
$ brew install overmind
$ brew install postgresql
$ brew tap luckyframework/homebrew-lucky
$ brew install lucky

For details see: https://luckyframework.org/guides/getting-started/installing

2. New Project

The cli guides you through a new project setup - with an option for a devise like authentication code. * Full - includes webpacker, css and all code for a frontend & API responses * API - no webpacker just api response code

$ lucky init
$ cd {project_name}

# install dependencies
$ script/setup

# start lucky with:
$ lucky dev

3. Organization

3.1. Actions

3.2. Namespacing

3.3. Internationalization

4. Generating these Docs

$ asciidoctor -D docs/crystal_lucky code/crystal_lucky/adoc/*

Home Page