Shard Detail

component_basics v0.1.0

Everything you need to get started with components in Lucky!
lucky lucky-framework components

Install & Use

Add the following code to your project's shard.yml under:

dependencies to use in production
- OR -
development_dependencies to use in development

  github: LuckyCastsVideos/component-basics


โ˜˜๏ธ Lucky Jumpstart

This is a template project for web applications using Lucky.

How to use it?

  • Click this link
  • Replace every instance of component_basics with your application name, for example:
    • mv src/ src/{your_app}.cr
    • rg component_basics -l | xargs sed -i '' 's/component_basics/{your_app}/g'
  • Run ./script/setup
  • Run docker-compose up
  • Run lucky dev

Why use a template?

There are quite a few things I find myself adding to every Lucky application out of the box, and this serves as a bit of a better starting point than the default generated application.

What's in the box?


  • ๐Ÿณ ย  A DockerCompose file for running your application database


  • ๐Ÿ’Ž ย  Up-to-date Crystal dependencies
  • ๐Ÿงถ ย  Up-to-date Yarn dependencies


  • ๐Ÿ˜ฝ ย  TailwindCSS for better styling
  • ๐Ÿ˜ป ย  TailwindUI for fancy components
  • ๐ŸŽ‰ ย  StimulusJS for JavaScript sprinkles
  • ๐Ÿš€ ย  TypeScript for keeping JavaScript cleaner


  • ๐Ÿณ ย  A Dockerfile that can run LuckyFlow specs

  • ๐Ÿค– ย  A handy dandy Dependabot configuration file

  • A working GitHub Actions workflow with: