Skip to content

The Material Board plugin for WordPress updates the appearance of your site's dashboard to a sleeker, more contemporary design based on Google's Material Design Guidelines. This plugin preserves your existing dashboard layout, avoids making any significant alterations, and doesn't include any branding or promotional content.

License

Notifications You must be signed in to change notification settings

fatihbalsoy/material-board

Repository files navigation

Alt text

The Material Dashboard plugin for WordPress updates the appearance of your site's dashboard to a sleeker, more contemporary design based on Google's Material Design Guidelines. This plugin preserves your existing dashboard layout, avoids making any significant alterations, and doesn't include any branding or promotional content. It's straightforward to use and comes at no cost.

Prerelease Download Demo WordPress Build Status

Screenshots

Alt text Alt text

Installation

Manually

  • Download the latest release of Material Dashboard here,
  • On your WordPress dashboard go to Plugins > Add New,
  • Click the Upload Plugin button near the header,
  • Select the downloaded zip archive,
  • Finally, activate the Material Dashboard plugin.

Git Updater (Automatic Updates)

  • Download the latest release of Git Updater here
  • On your WordPress dashboard go to Plugins > Add New,
  • Click the Upload Plugin button near the header,
  • Select the downloaded zip archive,
  • Activate the Git Updater plugin,
  • Go to Git Updater Settings > Install Plugin,
  • Input this repository's link into Plugin URI,
  • Click Install Plugin,
  • Finally, activate the Material Dashboard plugin.

NOTE

This plugin is still in its pre-release phase and is not yet available on the WordPress Plugin Directory.

Customization

Head over to Appearance > Material Dashboard to customize the dashboard colors and looks. Here are some of the available options:

  • Theme (Light, Dark, and System)
  • Colors (Primary and Accent colors)
  • Toggle Rounded Corners
  • Font (Mona, Hubot, Roboto, or WordPress)
  • Header Font (Serif or sans serif)
  • Icons (Material or WordPress)
  • Large App Bar (Bar or Menu on top)

Features

  • Dark mode
  • Admin bar
  • Side bar
  • Menus
  • Drop shadows
  • Buttons (Ripple Effect)
  • Inputs (Checkbox, Text Field, Slider)
  • Customization
  • Third-party plugin and theme support

Known Issues

  • Automatic system theme setting does not take effect until after two page refreshes.
  • Login screen looks janky because default values are not saved on initialization.

Setup & Build

Build Status

Download Node.js. Run any of the following commands:

# Install dependencies (only the first time)
npm install

# Run the local server at localhost:* (WordPress Playground) using WebAssembly and SQLite
npm i -g @wp-now/wp-now # first time
npm run dev:wasm # creates wp environment at ~/.wp-now

# Run the local server at localhost:8000 (WordPress) and localhost:8080 (phpMyAdmin) using Docker
npm run dev:docker

# Watch & compile source code without hosting a WordPress server
npm run dev

# Build for production in the build/ directory
npm run build

More helpful tips:

# Run different versions of WordPress and PHP
npm i -g @wp-now/wp-now # first time
wp-now start --path=build/ --wp=6.3 --php=8.0

Default User Credentials

username: admin

password: password

Contribution

Feel free to submit a pull request for one of the following:

  • New features
  • Support third-party plugins or themes
  • Fixing bugs and security vulnurabilities

Licenses

Material Design Dashboard, AGPL License 3.0.

This project depends on the following third-parties:

About

The Material Board plugin for WordPress updates the appearance of your site's dashboard to a sleeker, more contemporary design based on Google's Material Design Guidelines. This plugin preserves your existing dashboard layout, avoids making any significant alterations, and doesn't include any branding or promotional content.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project