slate

TODO: Write a description here This is a project written using Lucky. Enjoy!

Installation

TODO: Write installation instructions here

Usage

TODO: Write usage instructions here

Development

TODO: Write development instructions here

Setting up the project

See Install required dependencies for reference.

Install prerequisites

1. mise use -g crystal
2. git clone https://github.com/luckyframework/lucky_cli.git
3. shards install --without-development
4. shards build --production
5. cp bin/luck_cli ~/bin/
6. mise use -g bun
7. shards install
8. bun install
9. bun run build
10. Create a .env file with details that match those in docker-compose.yml DB_HOST=127.0.0.1 DB_PORT=6543 DB_USERNAME=lucky DB_PASSWORD=password
11. docker compose up -d postgres
12. crystal script/setup.cr
13. lucky dev

Contributing

1. Fork it (https://github.com/lowkeyliesmyth/slate/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• lowkey - creator and maintainer