nirlevi/lucky

☘️ Lucky Jumpstart

This is a template project for web applications using Lucky.

How to use it?

1. Click this link
2. Run ./script/setup
3. 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, included in Procfile.dev

Dependencies

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

Tooling

• 💨   TailwindCSS for better styling
• 🖋   Tailwind Typography for prose
• 📝   Tailwind Forms to make styling forms easier
• 🖥   Tailwind Aspect Ratio for setting fixed aspect ratios
• 🎉   StimulusJS for JavaScript sprinkles
• 🚀   TypeScript for keeping JavaScript cleaner

Functionality

• 📧   Email confirmation of users

CI/CD

• 🤖   A handy dandy Dependabot configuration file, and a workflow to handle auto-merging

• A working GitHub Actions workflow with:

  • 💃   Prettier
  • 💎   Crystal Format
  • 🦠   Ameba
  • 👓   Crystal Spec

Deployment options

• 🐳   Docker, which enables any Dockerfile-based deployment like:
  • Render
  • Digital Ocean Apps Platform
• 🟩   Render with a built-in render.yaml file
• 👾   Heroku with a built-in Procfile file