/heroku-buildpack-lucky

Primary LanguageShellMIT LicenseMIT

Official Lucky Framework Heroku Buildpack

You can create an app in Heroku with:

$ heroku create myapp --buildpack lucky-framework/lucky

The default behaviour is to use the latest crystal release. If you need to use a specific version create a .crystal-version file in your application root directory with the version that should be used (e.g. 0.17.1).

Requirements

You will need:

  • Setup your heroku config:

    • lucky_env variable: heroku config:set LUCKY_ENV=production
    • secret key base: heroku config:set SECRET_KEY_BASE=$(lucky gen.secret_key)
    • app domain: heroku config:set APP_DOMAIN=$(heroku apps:info | grep 'Web URL' | awk '{print $3}')
    • sendgrid key: heroku config:set SEND_GRID_KEY=unused

  • Configure your lucky and node buildpacks:

    • heroku buildpacks:add heroku/nodejs
    • heroku buildpacks:add lucky-framework/lucky

  • Attach a postgres database service:

    • heroku addons:create heroku-postgresql:hobby-dev

  • Ensure your crystal version is specified in a .crystal-version file

  • If your application was generated with lucky before 2021-Feb, you may need to add a shard target to your shard.yml file:

name: project_name

targets:
# replace project_name with the name of your project
+  project_name:
+    main: src/project_name.cr

Testing

To test a change to this buildpack, write a unit test in tests/run that asserts your change and run make test to ensure the change works as intended and does not break backwards compatibility.

More info