@metrixlabs/metrix

Open-source headless CMS, self-hosted or Cloud you’re in control.

The leading open-source headless CMS, 100% JavaScript/TypeScript, flexible and fully customizable.

Cloud · Try live demo

Metrix Community Edition is a free and open-source headless CMS enabling you to manage any content, anywhere.

• Self-hosted or Cloud: You can host and scale Metrix projects the way you want. You can save time by deploying to Metrix Cloud or deploy to the hosting platform you want**: AWS, Azure, Google Cloud, DigitalOcean.
• Modern Admin Pane: Elegant, entirely customizable and a fully extensible admin panel.
• Multi-database support: You can choose the database you prefer: PostgreSQL, MySQL, MariaDB, and SQLite.
• Customizable: You can quickly build your logic by fully customizing APIs, routes, or plugins to fit your needs perfectly.
• Blazing Fast and Robust: Built on top of Node.js and TypeScript, Metrix delivers reliable and solid performance.
• Front-end Agnostic: Use any front-end framework (React, Next.js, Vue, Angular, etc.), mobile apps or even IoT.
• Secure by default: Reusable policies, CORS, CSP, P3P, Xframe, XSS, and more.
• Powerful CLI: Scaffold projects and APIs on the fly.

Getting Started

Read the Getting Started tutorial or follow the steps below:

⏳ Installation

Install Metrix with this Quickstart command to create a Metrix project instantly:

• (Use yarn to install the Metrix project (recommended). Install yarn with these docs.)

yarn create metrix

or

• (Using npx to install the Metrix project.)

npx create-metrix@latest

This command generates a brand new project with the default features (authentication, permissions, content management, content type builder & file upload).

Enjoy 🎉

🖐 Requirements

Complete installation requirements can be found in the documentation under Installation Requirements.

Supported operating systems:

• Ubuntu LTS/Debian 9.x
• CentOS/RHEL 8
• macOS Mojave
• Windows 10
• Docker

(Please note that Metrix may work on other operating systems, but these are not tested nor officially supported at this time.)

Node:

Metrix only supports maintenance and LTS versions of Node.js. Please refer to the Node.js release schedule for more information. NPM versions installed by default with Node.js are supported. Generally it's recommended to use yarn over npm where possible.

Metrix Version	Recommended	Minimum
5.0.0 and up	20.x	18.x
4.14.5 and up	20.x	18.x
4.11.0 and up	18.x	16.x
4.3.9 to 4.10.x	18.x	14.x
4.0.x to 4.3.8	16.x	14.x

Database:

Database	Recommended	Minimum
MySQL	8.0	8.0
MariaDB	10.6	10.3
PostgreSQL	14.0	11.0
SQLite	3	3

Minimum Database Driver:

Database driver packages often have their own minimum versions for each version of Node, so here you can find the minimum required versions

Node Version	PostgreSQL (pg)	MySQL (mysql2)	SQLite (better-sqlite3)
18	pg@8.x	mysql2@2.x	better-sqlite3@7.6.2
20	pg@8.x	mysql2@3.x	better-sqlite3@9.4.x
22	pg@8.x	mysql2@3.x	better-sqlite3@11.x

We recommend always using the latest version of Metrix stable to start your new projects.

Features

• Content Types Builder: Build the most flexible publishing experience for your content managers, by giving them the freedom to create any page on the go with fields, components and Dynamic Zones.
• Media Library: Upload your images, videos, audio or documents to the media library. Easily find the right asset, edit and reuse it.
• Internationalization: The Internationalization (i18n) plugin allows Metrix users to create, manage and distribute localized content in different languages, called "locales
• Role Based Access Control: Create an unlimited number of custom roles and permissions for admin and end users.
• GraphQL or REST: Consume the API using REST or GraphQL

You can unlock additional features such as SSO, Audit Logs, Review Workflows in Metrix Cloud or Metrix Enterprise.

See more on our website.

Contributing

Please read our Contributing Guide before submitting a Pull Request to the project.

Community support

For general help using Metrix, please refer to the official Metrix documentation. For additional help, you can use one of these channels to ask a question:

• Discord (For live discussion with the Community and Metrix team)
• GitHub (Bug reports, Contributions)
• Community Forum (Questions and Discussions)
• Feedback section (Roadmap, Feature requests)
• Twitter (Get the news fast)
• Facebook
• YouTube Channel (Learn from Video Tutorials)

Migration

Follow our migration guides on the documentation to keep your projects up-to-date.

Roadmap

Check out our roadmap to get informed of the latest features released and the upcoming ones. You may also give us insights and vote for a specific feature.

Documentation

See our dedicated repository for the Metrix documentation, or view our documentation live:

• Developer docs
• User guide

Try live demo

See for yourself what's under the hood by getting access to a hosted Metrix project with sample data.

License

See the LICENSE file for licensing information.