README

Laravue

Laravue (pronounced /ˈlarəvjuː/) is a beautiful dashboard combination of Laravel, Vue.js and the UI Toolkit Element. The work is inspired by vue-element-admin with our love on top of that. With the powerful Laravel framework as the backend, Vue.js as the high performance on the frontend, Laravue appears to be a full-stack solution for an enterprise application level.

Documentation: https://doc.laravue.dev

Screenshot

Getting started

Prerequisites

Laravue is positioned as an enterprise management solution, and it is highly recommended to use it to start from scratch.
For existing Laravel project, you should check Laravue Core for integration.
Your machine needs to be ready for the latest Laravel and Node.js.

Installing

Manual

# Clone the project and run composer
composer create-project amirhossein-ceh/laravue
cd laravue

# Migration and DB seeder (after changing your DB settings in .env)
php artisan migrate --seed

# Generate JWT secret key
php artisan jwt:secret

# Install dependency - we recommend using Yarn instead of NPM since we get errors while using NPM
yarn install

# develop
yarn run dev # or yarn run watch

# Build on production
yarn run production

Docker

docker-compose up -d

Run database migration and seed within Docker container

# Get laravel docker container ID from containers list
docker ps

docker exec -it <container ID> php artisan migrate --seed 
# Where <container ID> is the "laravel" container name, ex: docker_laravel_1

yarn commands are also supported:

docker exec -it <container ID> yarn run watch 
# Where <container ID> is the "laravel" container name, ex: docker_laravel_1
...

Running the tests

Tests system is under development

Deployment and/or CI/CD

This project uses Envoy for deployment, and GitLab CI/CD. Please check Envoy.blade.php and .gitlab-ci.yml for more detail.

Built with

Laravel - The PHP Framework For Web Artisans
VueJS - The Progressive JavaScript Framework
Element - A Vue 2.0 based component library for developers, designers and product managers
Vue Admin Template - A minimal vue admin template with Element UI

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, please look at the release tags on this repository.

Authors

Tuan Duong - Initial work - tuandm.
Tony Tin Nguyen - Frontend and Designer - nguyenquangtin.

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Related projects

Laravue-core - Laravel package which provides core functionalities of Laravue.

Acknowledgements

vue-element-admin A magical vue admin which insprited Laravue project.
tui.editor - Markdown WYSIWYG Editor.
Echarts - A powerful, interactive charting and visualization library for browser.

Donate

If you find this project useful, you can buy me a coffee

amirhossein-ceh / laravue

Maintainers

Details