Skip to content

Latest commit

 

History

History
177 lines (43 loc) · 2.24 KB

README.md

File metadata and controls

177 lines (43 loc) · 2.24 KB
Raw

bloggify-sequelize

Version Downloads

Use Sequelize in Bloggify applications.

☁️ Installation

# Using npm
npm install --save bloggify-sequelize

# Using yarn
yarn add bloggify-sequelize

❓ Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
  2. For bug reports and feature requests, open issues. 🐛

📝 Documentation

Plugin Configuration

  • Object config:
    • uri (String): The database uri (if this is used, the other config fields will be ignored).
    • db_name (String): The database name
    • username (Object): The database username.
    • password (Object): The database password.
    • options (Object): The database options.
    • models_dir (String): The relative path to a directory containing models stored in files.
    • autosync (Boolean): Wheter to autosync the database (default: true).

The model objects can be accessed by requiring the module or accessing the Bloggify.models object.

After the module is initialized, the db field is appended to the Sequelize module, being the Sequelize instance. You can access the Sequelize instance using:

const seq = require("sequelize").db

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

  • bloggify-custom-app-template-sqlite
  • bloggify-custom-app-template-sqlite-with-auth

📜 License

MIT © Bloggify