website_v2

main branch1 version

main branchlatestAug 17, 2026

github.com/luckyframework/website

The Lucky website

39 stars

0 dependents

License: not declared

Installation

# Add this to your shard.yml
dependencies:
  website_v2:
    github: luckyframework/website
    branch: main

main is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal

>= 1.10.0

Author

Paul Smith

Target

website_v2 from src/website_v2.cr

Dependencies

Runtime Dependencies

cmark*github: amauryt/cr-cmark-gfm, branch: master
lucky~> 1.5.0github: luckyframework/lucky
carbon~> 0.6.0github: luckyframework/carbon
lexbor~> 3.1.3github: kostya/lexbor
lucky_env~> 0.3.0github: luckyframework/lucky_env
sitemapper~> 0.9.0github: jwoertink/sitemapper
cadmium_transliterator*github: cadmiumcr/transliterator, branch: master
carbon_sendgrid_adapter~> 0.6.0github: luckyframework/carbon_sendgrid_adapter

Development Dependencies

ameba~> 1.5.0github: crystal-ameba/amebadev
lucky_flow~> 0.10.0github: luckyframework/lucky_flowdev

README

Lucky's Website

This is the repository for Lucky's official website https://luckyframework.org/

Setting up the project

Install required dependencies
Ensure you have cmake and libxml2 installed for your system. These are required for some shard dependencies of this project
Run script/setup
Run lucky dev to start the app
Visit http://localhost:3000

Editing guides

Guides are located in the src/actions/guides directory. You can edit the markdown in each action file and view changes by running the Lucky app with lucky dev.

Adding a new guide

Create a new guide in src/actions/guides. Usually it is easiest to copy an existing guide as a starting point
Add the guide class to the appropriate category in the GuidesList
That's it! View your guide by running lucky dev and finding the guide in the sidebar.

Learning Lucky

Lucky uses the Crystal programming language. You can learn about Lucky from the Lucky Guides. Get help on our Discord server.