vuetify admin

Vuetify Admin

SPA Admin Framework for Vue.js running on top of REST APIs, built on Vuetify and comes with dedicated Vue CLI plugin for . Ready to use on Laravel 8 by using official Laravel Admin composer package, but can be used on every backend of your choice with your own data and authentication providers.

See full documentation
Check online demo -> go to admin and use pre-filled login (read only)
Check tutorial CodeSandbox -> use any login (fake writeable API)
This project was heavily inspired by React Admin made by awesome Marmelab Team

See how it works here.

Install

Select your most suitable guide :

• For basic presentation and quick install via the Vue CLI Plugin, go to getting started.
• For best initial starting showcase of Vuetify Admin features, follow this tutorial guide.
• If you choose Laravel as backend, follow this optimized guide.

Note on this main repo

It's contains all necessary projects to develop Vuetify Admin and run demo and tutorials :

• Vuetify Admin Library, the main admin library.
• Vuetify Admin Vue CLI Plugin, the associated Vue CLI plugin which contains all base code boilerplate for quick install and UI commands code generator.
• Laravel Admin, git submodule of composer package to use on fresh Laravel project which facilitates Vuetify Admin integration and includes server-side API commands generator.
• Bookstore Admin Demo, full-featured admin sample build on top of main Vuetify Admin Library.
• Bookstore Laravel Demo, suitable API backend for bookstore admin demo based on Laravel.
• Admin Tutorial, finished tutorial after following dedicated docs, ideal for quick learning in less than 15 minutes.
• API Platform Tutorial, finished tutorial after following dedicated docs. Good showcase of hydra API provider usage.
• Laravel Tutorial, finished tutorial after following dedicated docs which aims to made a good showcase of YAML driven development.
• Vue CLI base, clean basic Vuetify CLI project starter for proper install testing of VA Vue CLI plugin.
• Docs, documentation based on VuePress.

All of this projects are automatically linked together by symlinks thanks to yarn workspaces and composer for best library development experience. HMR from demo to admin library side-by-side is fully supported !

Usage

How to run tutorial

You can run tutorial directly inside CodeSandbox !

How to run demo locally

Be sure to have cloned this repo with git submodules. If not the case use git submodule init && git submodule update. The separate Laravel package should be cloned under packages/laravel sub folder.

Requirements :

• Yarn.
• Docker with docker-compose, required for quick-start run backend API. If you don't want it, follow dedicated instructions.
• Make for easy starting all necessary tools. For Windows users install it via scoop with scoop install make. Use make help for all detail commands.

In order to run demo :

yarn # install all yarn dependencies
make up-demo-laravel # run server api through docker (take a pastis if 1st time...)
make prepare-demo-laravel # initialize laravel app and inject dummy data (use it only at 1st launch)
make run-demo # compile all bookstore demo admin with HMR dev mode enabled

Admin panel should autostart at http://localhost:8080.

Run and build docs

Docs are hosted by VuePress. Use make run-docs to launch it on http://localhost:9000. make build-docs will generate static files inside docs root folder.

API documentation for all VA components are auto generated from source code thanks to Vue Docgen API.

Laravel Admin

A separate helper package is available for Laravel in order to have the quickest starting development experience as possible, combined to generators for high productivity, while highly respecting the pure traditional Laravel way to make CRUD resources. I included YAML based code generators, similarly as Blueprint.

Documentation

Documentation for Vuetify Admin can be found on the Okami101 website.

License

This project is open-sourced software licensed under the MIT license.