Avram

This project is still new. Guides will be posted when things are more complete.

Installation

Add this to your application's shard.yml:

dependencies:
  avram:
    github: luckyframework/avram

Usage

require "avram"

Contributing

1. Fork it ( https://github.com/luckyframework/avram/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Install docker and docker-compose: https://docs.docker.com/compose/install/
4. Run scripts/setup
5. Make your changes
6. Run scripts/test to run the specs, build shards, and check formatting
7. Commit your changes (git commit -am 'Add some feature')
8. Push to the branch (git push origin my-new-feature)
9. Create a new Pull Request

Testing

To run the tests:

1. Install docker and docker-compose: https://docs.docker.com/compose/install/
2. Run scripts/setup to set up the docker environment
3. 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.

Contributors

• paulcsmith Paul Smith - creator, maintainer
• mikeeus Mikias Abera - contributor