my_lucky_app

master branch1 version
  • master branchlatestFeb 3, 2022

github.com/robacarp/lucky_template

No description declared in shard.yml.

0 stars
0 dependents
License: not declared

Installation

# Add this to your shard.yml
dependencies:
  my_lucky_app:
    github: robacarp/lucky_template
    branch: master

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

Then run:

shards install

shard.yml

Crystal
1.3.2
Target
  • my_lucky_app from src/my_lucky_app.cr

Dependencies

Runtime Dependencies

  • lucky~> 0.29.0github: luckyframework/lucky
  • breeze~> 0.2github: luckyframework/breeze
  • carbon~> 0.2.0github: luckyframework/carbon
  • pundit*github: stephendolan/pundit
  • mosquito~> 1.0.0.rc1github: mosquito-cr/mosquito
  • lucky_env~> 0.1.4github: luckyframework/lucky_env
  • lucky_task~> 0.1.1github: luckyframework/lucky_task
  • honeybadger*github: honeybadger-io/honeybadger-crystal
  • carbon_sendgrid_adapter~> 0.2.0github: luckyframework/carbon_sendgrid_adapter

Development Dependencies

  • lucky_flow~> 0.7.3github: luckyframework/lucky_flowdev

README

Lucky Template

This is a project template for projects using:

Features

  • User registration/logins/forgot passwords.
  • Admin portal.
  • Admin "sudo" mode, to view or act as a user.
  • /ping endpoint, populated at docker build time.

Setting up your project

  1. Clone this template
  2. Install dependencies: shards install and then yarn install
  3. Find and replace all of "my_lucky_app" with your name:
  • ag my_lucky_app to find them in file contents.
  • find ./ -type f -exec sed -i -e 's/my_lucky_app/real_app_name/g' {} \; if you're willing.
  • Don't forget about renaming the app_root: find . -iname 'my_lucky_app*'.
  1. Migrate the database: lucky db.setup
  2. Run lucky dev to start the app.
  3. Visit http://localhost:3001

Deploying

There are utility scripts provided to aid in building and releasing to heroku:

  • script/docker/build will build and tag a docker container for release.
  • script/docker/run will run the tagged container locally.
    • script/docker/run <command> will boot the container and run the command. For example, script/docker/run sh will open a shell into the container.
    • To run the worker instead of the server export the environment variable DYNO=worker.
  • script/docker/deploy will:
    • tag the container for deploy to heroku.
    • push it to registry.heroku.com.
    • run container:release
    • and optionally run migrations.

Documentation

Read the API docs

Built from the current release. The first visit to a release nobody has asked for starts its build.

Links

This branch

Branch
master
Seen
Feb 3, 2022
Crystal
1.3.2
Indexed
yes

Dependents

No indexed shard depends on this one yet.

Repository

github.com/robacarp/lucky_template

Metadata

Created
Aug 12, 2026
Updated
Aug 15, 2026
Synced
Aug 15, 2026
Versions
1