https://github.com/luckyframework/avram

A Crystal database wrapper for reading, writing, and migrating Postgres databases.
https://github.com/luckyframework/avram

crystal hacktoberfest lucky-framework orm

Last synced: 8 days ago
JSON representation

A Crystal database wrapper for reading, writing, and migrating Postgres databases.

• Host: GitHub
• URL: https://github.com/luckyframework/avram
• Owner: luckyframework
• License: mit
• Created: 2019-02-02T15:07:51.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2024-10-21T01:56:29.000Z (19 days ago)
• Last Synced: 2024-10-25T01:22:17.693Z (15 days ago)
• Topics: crystal, hacktoberfest, lucky-framework, orm
• Language: Crystal
• Homepage: https://luckyframework.github.io/avram/
• Size: 25.7 MB
• Stars: 164
• Watchers: 10
• Forks: 64
• Open Issues: 205
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-crystal - avram - A database wrapper for reading, writing, and migrating Postgres databases. (ORM/ODM Extensions)
• awesome-crystal - avram - A database wrapper for reading, writing, and migrating Postgres databases (ORM/ODM Extensions)

README

        
# Avram

[![API Documentation Website](https://img.shields.io/website?down_color=red&down_message=Offline&label=API%20Documentation&up_message=Online&url=https%3A%2F%2Fluckyframework.github.io%2Favram%2F)](https://luckyframework.github.io/avram)

### Why Avram?

The name comes from [Henriette Avram](https://en.wikipedia.org/wiki/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`:

```yaml

dependencies:

  avram:

    github: luckyframework/avram

```

## Usage

```crystal

require "avram"

```

## Contributing

1. Fork it ( https://github.com/luckyframework/avram/fork )

1. Create your feature branch (git checkout -b my-new-feature)

1. Install docker and docker-compose: https://docs.docker.com/compose/install/

1. Run `script/setup`

1. Make your changes

1. Run `script/test` to run the specs, build shards, and check formatting

1. Commit your changes (git commit -am 'Add some feature')

1. Push to the branch (git push origin my-new-feature)

1. Create a new Pull Request

## Testing

To run the tests:

1. Install docker and docker-compose: https://docs.docker.com/compose/install/

1. Run `script/setup` to set up the docker environment

1. 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

- [paulcsmith](https://github.com/paulcsmith) Paul Smith - creator, maintainer

- [mikeeus](https://github.com/mikeeus) Mikias Abera - contributor