All Projects → luckyframework → avram

luckyframework / avram

Licence: MIT license
A Crystal database wrapper for reading, writing, and migrating Postgres databases.

Programming Languages

crystal
512 projects
HTML
75241 projects

Projects that are alternatives of or similar to avram

website
The Lucky website
Stars: ✭ 33 (-75.74%)
Mutual labels:  lucky-framework
lucky flow
Automated browser tests for web applications. Similar to Ruby's Capybara.
Stars: ✭ 50 (-63.24%)
Mutual labels:  lucky-framework
shield
Comprehensive security for Lucky framework
Stars: ✭ 46 (-66.18%)
Mutual labels:  lucky-framework
Lucky
A full-featured Crystal web framework that catches bugs for you, runs incredibly fast, and helps you write code that lasts.
Stars: ✭ 2,174 (+1498.53%)
Mutual labels:  lucky-framework

Avram

API Documentation Website

Why Avram?

The name comes from Henriette Avram.

Henriette Davidson Avram (October 7, 1919 – April 22, 2006) was a computer programmer and systems analyst who developed the MARC format (Machine Readable Cataloging), the international data standard for bibliographic and holdings information in libraries.

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 script/setup
  5. Make your changes
  6. Run script/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 script/setup to set up the docker environment
  3. Run script/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

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].