Skip to content

Latest commit

 

History

History
84 lines (60 loc) · 2.14 KB

README.md

File metadata and controls

84 lines (60 loc) · 2.14 KB
Raw

🗺 Content-Type Explorer

Content-Type Explorer is a Strapi plugin that visualizes your content types and their relationships like an ERD (Entity Relationship Diagram).

image

image

Usage

⌨️ Installation

npm i strapi-content-type-explorer

⚙️ Options

  • Field Data Types
  • Field Icons
  • Default Fields: toggle createdBy, createdAt, updatedBy, updatedAt
  • Relational Fields Only
  • admin:: Types
  • plugin:: Types
  • Edges
  • Snap to Grid
  • Background Pattern
  • Edge Type

Tip

If you encounter lags while dragging boxes, try changing edge types. "Smart" edges cause performance issues (this should be fixed in future releases)

🛠️ Development

🏗️ Setup

  1. Create a new strapi project
  2. Clone the plugin repo inside src/plugins/ folder:
├── 📁 config
│   └── plugins.js (👈️ create this)
└── 📁 plugins
    └── 📁 strapi-content-type-explorer (👈️ clone here)

cd src/plugins
git clone https://github.com/ShahriarKh/strapi-content-type-explorer.git
  1. Create config/plugins.js if it doesn't exist and add this:
module.exports = {
  "strapi-content-type-explorer": {
    enabled: true,
    resolve: "./src/plugins/strapi-content-type-explorer",
  },
};
  1. Go to plugins/strapi-content-type-explorer and install dependencies:
cd src/plugins/strapi-content-type-explorer
npm i
  1. Run strapi and start developing!
npm run strapi develop -- --watch-admin

🚀 Collaboration

Have a question or found a bug? Feel free to open an issue. Wanna contribute and improve the plugin? PRs are welcome!

Links