A dashboard for Varying Vagrant Vagrants (VVV) featuring a Material Design UI.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
api
assets
config
src
.babelrc
.editorconfig
.eslintrc
.gitignore
.tern-project
CHANGELOG.md
LICENSE
README.md
composer.json
composer.lock
dashboard-custom.php
index.html
index.php
package.json
server.js
update.sh
webpack.config.dev.js
webpack.config.prod.js

README.md

Material Dashboard for VVV

What is it?

This is a custom dashboard for Varying Vagrant Vagrants (VVV) using Material Design and written in React and Redux.

If you're a WordPress developer and don't know about VVV, you're really missing out.

If you don't care about WordPress, though, then I'm afraid you're not going to have much fun here.

Okay, what does it look like?

Material VVV Screenshot

But why?

I needed an excuse to experiment with Redux, Material UI and Webpack, but didn't feel like writing another to-do or counter application.

May I have it?

Download the pre-built project and unzip it inside the <VVV ROOT>/www/default folder.

You should see a new material-dashboard folder. Now enter it and copy the dashboard-custom.php file into the parent folder to activate the dashboard.

I want to build the dashboard myself

The project requires the NPM and Composer package management applications, both of which are provided by VVV, so you may not need to install anything else. If you want to use the host operating system, though, you'll have to install these first.

  1. Using the terminal, cd into the <VVV ROOT>/www/default directory.
  2. Clone the repository into the material-dashboard directory by running git clone https://github.com/goblindegook/vvv-material-dashboard.git material-dashboard.
  3. Enter the material-dashboard directory you've just created.
  4. Execute npm install to install dependencies.
  5. Execute npm run build to build the project.
  6. Execute npm run activate to copy the dashboard override to the parent directory.

If you're compiling from within VVV, please note that the npm run build command will occasionally fail with a "process out of memory" error. Re-running the command has worked for me.

Your new dashboard interface should now be available at http://vvv/. Enjoy!

Will you continue to develop and support it?

I can neither confirm nor deny the existence of a roadmap.

Show me something else

Material Dashboard is not the only option out there, go ahead and give these others a try: