Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.67 KB

README.md

File metadata and controls

47 lines (31 loc) · 1.67 KB

☘️ 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/component_basics.cr 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?

Development

  • 🐳   A DockerCompose file for running your application database

Dependencies

  • 💎   Up-to-date Crystal dependencies
  • 🧶   Up-to-date Yarn dependencies

Tooling

CI/CD

  • 🐳   A Dockerfile that can run LuckyFlow specs

  • 🤖   A handy dandy Dependabot configuration file

  • A working GitHub Actions workflow with: