| 1 | # @adonisjs/lucid
|
| 2 |
|
| 3 | <br />
|
| 4 |
|
| 5 | [![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url]
|
| 6 |
|
| 7 | ## Introduction
|
| 8 | SQL ORM for AdonisJS built on top of Knex. Comes with a db query builder, Active record ORM, migrations, seeders and model factories.
|
| 9 |
|
| 10 | ## Official Documentation
|
| 11 | The documentation is available on the [Lucid website](https://lucid.adonisjs.com/docs/introduction)
|
| 12 |
|
| 13 | ## Contributing
|
| 14 | 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.
|
| 15 |
|
| 16 | We encourage you to read the [contribution guide](https://github.com/adonisjs/.github/blob/main/docs/CONTRIBUTING.md) before contributing to the framework.
|
| 17 |
|
| 18 | ### Run tests locally
|
| 19 | Easiest way to run tests is to launch the redis cluster using docker-compose and `docker-compose.yml` file.
|
| 20 |
|
| 21 | ```sh
|
| 22 | docker-compose up -d
|
| 23 | npm run test
|
| 24 | ```
|
| 25 |
|
| 26 | ## Code of Conduct
|
| 27 | 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).
|
| 28 |
|
| 29 | ## License
|
| 30 | AdonisJS Lucid is open-sourced software licensed under the [MIT license](LICENSE.md).
|
| 31 |
|
| 32 | [gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/adonisjs/lucid/checks.yml?style=for-the-badge
|
| 33 | [gh-workflow-url]: https://github.com/adonisjs/lucid/actions/workflows/checks.yml "Github action"
|
| 34 |
|
| 35 | [npm-image]: https://img.shields.io/npm/v/@adonisjs/lucid/latest.svg?style=for-the-badge&logo=npm
|
| 36 | [npm-url]: https://www.npmjs.com/package/@adonisjs/lucid/v/latest "npm"
|
| 37 |
|
| 38 | [typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
|
| 39 |
|
| 40 | [license-url]: LICENSE.md
|
| 41 | [license-image]: https://img.shields.io/github/license/adonisjs/lucid?style=for-the-badge
|