Skip to content
This repository has been archived by the owner on Jul 2, 2021. It is now read-only.

Lund-Org/cherry-sequelize-connector

Repository files navigation

Cherry Sequelize Connector

Build Status Maintainability Test Coverage

A plugin to use Sequelize as the orm in cherry 🍒

Installation

Use the package manager npm to install Cherry Sequelize Connector.

npm install @lund-org/cherry-sequelize-connector

To start the tests, a docker-compose is available.

docker-compose.exe -f etc/docker-compose.yml up -d

Usage

Checkout the example in the example folder of cherry. Of course, you need a cherry app to use this connector :

const Cherry = require('@lund-org/cherry')
const CherrySequelizeConnector = require('@lund-org/cherry-sequelize-connector')

const options = {
  ...
  plugins: [CherrySequelizeConnector]
  ...
}

const cherry = new Cherry()
cherry.configure(options)
cherry.start(options)

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT