https://github.com/moigagoo/norm

A Nim ORM for SQLite and Postgres
https://github.com/moigagoo/norm

database hacktoberfest nim nim-lang nimble orm postgresql sqlite

Last synced: 3 months ago
JSON representation

A Nim ORM for SQLite and Postgres

• Host: GitHub
• URL: https://github.com/moigagoo/norm
• Owner: moigagoo
• License: mit
• Created: 2018-09-25T11:28:51.000Z (over 6 years ago)
• Default Branch: develop
• Last Pushed: 2024-07-05T19:14:17.000Z (7 months ago)
• Last Synced: 2024-07-31T09:08:57.753Z (6 months ago)
• Topics: database, hacktoberfest, nim, nim-lang, nimble, orm, postgresql, sqlite
• Language: Nim
• Homepage: https://norm.nim.town
• Size: 4.4 MB
• Stars: 380
• Watchers: 10
• Forks: 34
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-nim - norm - Norm is an object-oriented, framework-agnostic ORM for Nim that supports SQLite and PostgreSQL. (Data / Database)

README

        
# Welcome to Norm!

**Norm** is an object-driven, framework-agnostic ORM for Nim that supports SQLite and PostgreSQL.

- [Documentation](https://norm.nim.town/) (built with [nimibook](https://github.com/pietroppeter/nimibook))

- [API index](https://norm.nim.town/apidocs/theindex.html)

- [norman](https://github.com/moigagoo/norman): scaffolder and migration manager for Norm

- [shopapp](https://github.com/moigagoo/shopapp): a proof-of-concept for a webapp created with Karax for frontend, Jester for API server, Norm for ORM, and Norman for migration management

## Installation

Install Norm with [Nimble](https://github.com/nim-lang/nimble):

    $ nimble install -y norm

Add Norm to your .nimble file:

    requires "norm"

Norm requires Nimble 0.14.0 sonmake sure you have the latest Nimble installed by running:

    $ nimble install -y nimble

## Contributing

Any contributions are welcome: pull requests, code reviews, documentation improvements, bug reports, and feature requests.

-   See the [issues on GitHub](http://github.com/moigagoo/norm/issues).

-   Run the tests before and after you change the code.

    The recommended way to run the tests is via nimble commands:

    

        $ nimble startContainers                                # Starts docker containers needed for testing

        $ nimble startContainers sudo                           # Starts docker containers using sudo

        $ nimble allTests                                       # run all test suites

        $ nimble singleTest tests/common/tmodel.nim             # run a single/list of test suite/s

        $ nimble stopContainers                                 # Stops and shuts down docker-containers

        $ nimble startContainers sudo                           # Stops docker container using sudo

-   Use camelCase instead of snake_case.

-   New procs must have a documentation comment. If you modify an existing proc, update the comment.

-   Apart from the code that implements a feature or fixes a bug, PRs are required to ship necessary tests and a changelog updates.

## ❤ Contributors ❤

Norm would not be where it is today without the efforts of these fine folks: [https://github.com/moigagoo/norm/graphs/contributors](https://github.com/moigagoo/norm/graphs/contributors).