Lucky Template

This is a project template for projects using:

• Lucky v0.29
• Tailwind CSS v3.0
• Mosquito Jobs v1.0

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.