osDXP Dashboard

An Augmentation of WordPress, creating a task-oriented Digital Experience Platform environment.
Explore osDXP Dashboard docs »

Report bug · Request feature · Modules · Partners

Table of contents

• Quick start
• Requirements
• Status
• Bugs and feature requests
• Documentation
• Contributing
• Community
• Versioning
• Changelog
• License

Quick start

Several quick start options are available:

• Download the latest release.
• Clone the repo: git clone https://github.com/osDXP/osdxp-dashboard.git (run composer install after cloning)
• Install with Composer: composer require osDXP/osdxp-dashboard

Read the Getting started page for more information.

Requirements

osDXP Dashboard is dependent on:

• Minimum PHP version 7.2
• Minimum WordPress version 5.2

Status

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

osDXP Dashboard's documentation, included in the docs repo of the osDXP organization, is built with MkDocs and Material for MkDocs and publicly hosted on GitHub Pages at https://osdxp.github.io/docs/. The docs may also be run locally.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Community

Get updates on osDXP Dashboard's development and chat with the project maintainers and community members.

• Follow @osDXP on Twitter.
• Join the official Slack room.
• Reach out to us on our website

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, osDXP Dashboard is maintained under the Romantic Versioning guidelines. Sometimes we screw up, but we adhere to those rules whenever possible.

Changelog

See the Releases section of our GitHub project for changelogs for each release version of osDXP Dashboard, or a historical changelog can be found in the repo, here.

License

osDXP Dashboard is released under the GPLv2 License.