ambiser
/
strapi-content-type-explorer
mirror of https://github.com/ShahriarKh/strapi-content-type-explorer.git
9
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
🗺 Content-Type Explorer is a Strapi plugin that visualizes your content types and their relationships like an ERD (Entity Relationship Diagram).
43 Commits
2 Branches
5 Tags
1.8 MiB
JavaScript 95.9%
CSS 4.1%
 
 
Go to file
Shahriar (Sara) d7f82f838f 0.2.2 2024-01-21 19:51:54 +03:30
.github/workflows allow manual release 2024-01-20 02:04:31 +03:30
admin/src code cleanup 2024-01-20 01:16:30 +03:30
server fix api route 2024-01-21 18:16:53 +03:30
.gitignore refactored RelationIcon and removed style-dcomponents 2023-07-15 01:56:01 +03:30
LICENSE Initial commit 2023-07-14 02:42:24 +03:30
README.md Update README.md 2024-01-18 20:57:34 +03:30
package-lock.json 0.2.2 2024-01-21 19:51:54 +03:30
package.json 0.2.2 2024-01-21 19:51:54 +03:30
strapi-admin.js start refactoring api 2024-01-19 17:02:57 +03:30
strapi-server.js update folder structure 2023-07-14 02:52:55 +03:30

README.md

🗺 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