https://github.com/robacarp/lucky_template
https://github.com/robacarp/lucky_template
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/robacarp/lucky_template
- Owner: robacarp
- Created: 2022-02-02T20:47:39.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-03T20:21:58.000Z (over 4 years ago)
- Last Synced: 2025-02-05T21:35:46.279Z (over 1 year ago)
- Language: Crystal
- Size: 84 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Lucky Template
This is a project template for projects using:
- [Lucky](https://luckyframework.org) v0.29
- [Tailwind CSS](https://tailwindcss.com/) v3.0
- [Mosquito Jobs](https://mosquito-cr.github.io/) 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
1. Install dependencies: `shards install` and then `yarn install`
1. 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`
1. Run `lucky dev` to start the app.
1. Visit [http://localhost:3001](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 ` 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.