khodo

This is a project written using Lucky. Enjoy!

Quick setup

You can quickly get started with this app on Linux (Mac too possibly) if you have the following available:

• Docker
• Docker Compose
• openssl (this is only needed to generate a random key - you can come up with your own)
• curl or something like wget

Run the following instructions, once you have the above:

curl -L https://gitlab.com/ntumbuka/khodo/-/raw/develop/quick-setup.sh?ref_type=heads | sh -s

Setting up the project for development

1. Install required dependencies
2. Update database settings in config/database.cr
3. Run script/setup
4. Run lucky dev to start the app

Using Docker for development

1. Install Docker
2. Run docker compose up

The Docker container will boot all of the necessary components needed to run your Lucky application. To configure the container, update the docker-compose.yml file, and the docker/development.dockerfile file.

Learning Lucky

Lucky uses the Crystal programming language. You can learn about Lucky from the Lucky Guides.