This project is still new. Guides will be posted when things are more complete.
Add this to your application's shard.yml
:
dependencies:
avram:
github: luckyframework/avram
require "avram"
- Fork it ( https://github.com/luckyframework/avram/fork )
- Create your feature branch (git checkout -b my-new-feature)
- Install docker and docker-compose: https://docs.docker.com/compose/install/
- Run
scripts/setup
- Make your changes
- Run
scripts/test
to run the specs, build shards, and check formatting - Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request
To run the tests:
- Install docker and docker-compose: https://docs.docker.com/compose/install/
- Run
scripts/setup
to set up the docker environment - Run
scripts/test
to run the specs, build shards, and check formatting
You can run individual tests like this: docker-compose run --rm app crystal spec path/to/spec.cr
Remember to run
docker-compose down
when you're done. This will stop the Crystal container.
- paulcsmith Paul Smith - creator, maintainer
- mikeeus Mikias Abera - contributor