https://github.com/adonisjs/lucid

AdonisJS SQL ORM. Supports PostgreSQL, MySQL, MSSQL, Redshift, SQLite and many more
https://github.com/adonisjs/lucid

active-record first-party-package knexjs

Last synced: 3 months ago
JSON representation

AdonisJS SQL ORM. Supports PostgreSQL, MySQL, MSSQL, Redshift, SQLite and many more

• Host: GitHub
• URL: https://github.com/adonisjs/lucid
• Owner: adonisjs
• License: mit
• Created: 2015-09-07T20:08:31.000Z (almost 9 years ago)
• Default Branch: develop
• Last Pushed: 2024-03-26T21:15:21.000Z (3 months ago)
• Last Synced: 2024-03-27T21:15:19.633Z (3 months ago)
• Topics: active-record, first-party-package, knexjs
• Language: TypeScript
• Homepage: https://lucid.adonisjs.com/
• Size: 5.04 MB
• Stars: 967
• Watchers: 26
• Forks: 187
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Lists

• awesome-adonisjs-packages - Adonis Lucid - Official SQL ORM. (Databases, ORMs, Migrations & Seeding)
• awesome-stars - lucid
• awesome-stars - adonisjs/lucid - AdonisJS SQL ORM. Supports PostgreSQL, MySQL, MSSQL, Redshift, SQLite and many more (TypeScript)
• awesome-faker - lucid - AdonisJS SQL ORM. Supports PostgreSQL, MySQL, MSSQL, Redshift, SQLite and many more. (Projects using `@faker-js/faker`)

README

        
# @adonisjs/lucid




[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url]

## Introduction

SQL ORM for AdonisJS built on top of Knex. Comes with a db query builder, Active record ORM, migrations, seeders and model factories.

## Official Documentation

The documentation is available on the [Lucid website](https://lucid.adonisjs.com/docs/introduction)

## Contributing

One of the primary goals of AdonisJS is to have a vibrant community of users and contributors who believes in the principles of the framework.

We encourage you to read the [contribution guide](https://github.com/adonisjs/.github/blob/main/docs/CONTRIBUTING.md) before contributing to the framework.

### Run tests locally

Easiest way to run tests is to launch the redis cluster using docker-compose and `docker-compose.yml` file.

```sh

docker-compose up -d

npm run test

```

## Code of Conduct

In order to ensure that the AdonisJS community is welcoming to all, please review and abide by the [Code of Conduct](https://github.com/adonisjs/.github/blob/main/docs/CODE_OF_CONDUCT.md).

## License

AdonisJS Lucid is open-sourced software licensed under the [MIT license](LICENSE.md).

[gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/adonisjs/lucid/checks.yml?style=for-the-badge

[gh-workflow-url]: https://github.com/adonisjs/lucid/actions/workflows/checks.yml "Github action"

[npm-image]: https://img.shields.io/npm/v/@adonisjs/lucid/latest.svg?style=for-the-badge&logo=npm

[npm-url]: https://www.npmjs.com/package/@adonisjs/lucid/v/latest "npm"

[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript

[license-url]: LICENSE.md

[license-image]: https://img.shields.io/github/license/adonisjs/lucid?style=for-the-badge