github.com/pjdufour-truss/pop@v4.11.2-0.20190705085848-4c90b0ff4d5a+incompatible/README.md (about)

     1  <p align="center"><img src="logo.png" width="150" height="150"></p>
     2  
     3  <p align="center">
     4      <a href="https://godoc.org/github.com/gobuffalo/pop"><img src="https://godoc.org/github.com/gobuffalo/pop?status.svg" alt="GoDoc" /></a>
     5      <a href="https://dev.azure.com/stanislasmichalak/pop/_build/latest?definitionId=1&branchName=master"><img src="https://dev.azure.com/stanislasmichalak/pop/_apis/build/status/gobuffalo.pop?branchName=master" alt="Build Status" /></a>
     6  </p>
     7  
     8  # POP
     9  
    10  ## A Tasty Treat For All Your Database Needs
    11  
    12  So what does Pop do exactly? Well, it wraps the absolutely amazing [https://github.com/jmoiron/sqlx](https://github.com/jmoiron/sqlx) library. It cleans up some of the common patterns and work flows usually associated with dealing with databases in Go.
    13  
    14  Pop makes it easy to do CRUD operations, run migrations, and build/execute queries.
    15  
    16  Pop, by default, follows conventions that were influenced by the [ActiveRecord](http://www.rubyonrails.org) Ruby gem. What does this mean?
    17  
    18  * Tables must have an "id" column and a corresponding "ID" field on the `struct` being used.
    19  * If there is a `timestamp` column named `created_at`, and a `CreatedAt time.Time` attribute on the `struct`, it will be set with the current time when the record is created.
    20  * If there is a `timestamp` column named `updated_at`, and a `UpdatedAt time.Time` attribute on the `struct`, it will be set with the current time when the record is updated.
    21  * Default database table names are lowercase, plural, and underscored versions of the `struct` name. Examples: User{} is "users", FooBar{} is "foo_bars", etc...
    22  
    23  Want to know more? Take a look at the documentation!
    24  
    25  ## Documentation
    26  
    27  Please visit [http://gobuffalo.io](https://gobuffalo.io/docs/db/getting-started) for the latest documentation, examples, and more.
    28  
    29  ### Quick Start
    30  * [CLI Installation](https://gobuffalo.io/docs/db/toolbox)
    31  * [Configuration](https://gobuffalo.io/docs/db/configuration)
    32  
    33  ## Shoulders of Giants
    34  
    35  Pop would not be possible if not for all of the great projects it depends on. Please see [SHOULDERS.md](SHOULDERS.md) to see a list of them.
    36  
    37  ## Contributing
    38  
    39  First, thank you so much for wanting to contribute! It means so much that you care enough to want to contribute. We appreciate every PR from the smallest of typos to the be biggest of features.
    40  
    41  To contribute, please read the contribution guidelines: [CONTRIBUTING](.github/CONTRIBUTING.md)