https://github.com/stephendolan/lucky_jumpstart
Get up and running quickly with Lucky!
https://github.com/stephendolan/lucky_jumpstart
crystal lucky-framework
Last synced: 11 months ago
JSON representation
Get up and running quickly with Lucky!
- Host: GitHub
- URL: https://github.com/stephendolan/lucky_jumpstart
- Owner: stephendolan
- License: mit
- Created: 2020-08-11T01:54:53.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-03-16T20:01:20.000Z (about 2 years ago)
- Last Synced: 2025-03-30T17:01:52.542Z (12 months ago)
- Topics: crystal, lucky-framework
- Language: Crystal
- Homepage: https://luckycasts.com
- Size: 3.22 MB
- Stars: 59
- Watchers: 2
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# ☘️ Lucky Jumpstart
This is a template project for web applications using [Lucky](https://luckyframework.org).
[](https://github.com/stephendolan/lucky_jumpstart/actions/workflows/lucky.yml)
### How to use it?
1. Click [this link](https://github.com/stephendolan/lucky_jumpstart/generate)
1. Run `./script/setup`
1. 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](https://docs.docker.com/compose/) file for running your application database, included in `Procfile.dev`
#### Dependencies
- 💎 Up-to-date Crystal dependencies
- 🧶 Up-to-date Yarn dependencies
#### Tooling
- 💨 [TailwindCSS](https://tailwindcss.com) for better styling
- 🖋 [Tailwind Typography](https://tailwindcss.com/docs/typography-plugin) for prose
- 📝 [Tailwind Forms](https://github.com/tailwindlabs/tailwindcss-forms) to make styling forms easier
- 🖥 [Tailwind Aspect Ratio](https://github.com/tailwindlabs/tailwindcss-aspect-ratio) for setting fixed aspect ratios
- 🎉 [StimulusJS](https://stimulusjs.org) for JavaScript sprinkles
- 🚀 [TypeScript](https://typescript.org) for keeping JavaScript cleaner
#### Functionality
- 📧 Email confirmation of users
#### CI/CD
- 🤖 A handy dandy [Dependabot](https://dependabot.com/) configuration file, and a workflow to handle auto-merging
- A working GitHub Actions workflow with:
- 💃 [Prettier](https://prettier.io/)
- 💎 [Crystal Format](https://crystal-lang.org/reference/using_the_compiler/#crystal-tool-format)
- 🦠 [Ameba](https://github.com/crystal-ameba/ameba)
- 👓 [Crystal Spec](https://crystal-lang.org/api/latest/Spec.html)
#### Deployment options
- 🐳 [Docker](https://www.docker.com), which enables any Dockerfile-based deployment like:
- [Render](https://render.com)
- [Digital Ocean Apps Platform](https://www.digitalocean.com/products/app-platform)
- 🟩 [Render](https://render.com) with a built-in `render.yaml` file
- 👾 [Heroku](https://luckyframework.org/guides/deploying/heroku) with a built-in `Procfile` file