{"id":15019548,"url":"https://github.com/tuandm/laravue-core","last_synced_at":"2025-04-05T17:07:44.018Z","repository":{"id":34292240,"uuid":"172311651","full_name":"tuandm/laravue-core","owner":"tuandm","description":"Laravel package to provide core functionalities of Laravue dashboard","archived":false,"fork":false,"pushed_at":"2023-04-03T08:38:08.000Z","size":3240,"stargazers_count":150,"open_issues_count":26,"forks_count":49,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-29T16:07:49.281Z","etag":null,"topics":["laravel","php","vue","vuejs"],"latest_commit_sha":null,"homepage":"https://laravue.dev","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tuandm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-02-24T08:03:37.000Z","updated_at":"2024-04-15T14:05:34.000Z","dependencies_parsed_at":"2024-06-19T00:24:09.727Z","dependency_job_id":"b766c233-741d-4d01-9a50-e1ceaac6fb80","html_url":"https://github.com/tuandm/laravue-core","commit_stats":{"total_commits":45,"total_committers":6,"mean_commits":7.5,"dds":"0.28888888888888886","last_synced_commit":"f84c15e26d56805c5802e662dc7d804d9b9b6911"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tuandm%2Flaravue-core","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tuandm%2Flaravue-core/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tuandm%2Flaravue-core/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tuandm%2Flaravue-core/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tuandm","download_url":"https://codeload.github.com/tuandm/laravue-core/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247369952,"owners_count":20927928,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["laravel","php","vue","vuejs"],"created_at":"2024-09-24T19:53:40.722Z","updated_at":"2025-04-05T17:07:43.986Z","avatar_url":"https://github.com/tuandm.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Laravue Core\n\nThe Laravel package to provide core functionalities for a beautiful [Laravel dashboard](https://laravue.dev)\n\nDemo: https://core.laravue.dev\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"900\" src=\"https://core.laravue.dev/images/laravue-core.jpg\"\u003e\n\u003c/p\u003e\n\n## Getting Started\n[Laravue](https://github.com/tuandm/laravue) provides necessary Element UI and rich features for an enterprise admin dashboard, therefore it's highly recommended to use for starting a project. The following instructions are for intergrating core features of Laravue to existing Laravel project or to experiement with it.\n\n### Prerequisites\n[Laravue](https://github.com/tuandm/laravue) is built on top of [Laravel](https://laravel.com) and  so you have to check [Laravel's system requirement](https://laravel.com/docs/5.8/installation#server-requirements) and make sure your your [NodeJS](https://nodejs.org/en/) is ready before starting.\n\n### Installing\nInstall laravue-core package with `composer`\n```\ncomposer require tuandm/laravue-core\n```\n\n#### 1.a Setup Laravue with all-in-one command\n```\nphp artisan laravue:setup\n```\nThis command will do these steps:\n- Setup JWT secret and API endpoint\n- Publish Laravue vendor packages/assets\n- Install NPM dependencies\n- Create .babelc file (if it doesn't exist)\n- Setup webpack.mix.js (please backup this file to make sure the current setting will not be lost)\n\n![Laravue setup](https://core.laravue.dev/images/laravue.gif)\n\n#### 1.b Manual setup\nIt's recommended to use [laravue:setup command](#setup-laravue). If you want to manually install, you can do following setps:\n\n##### .env file\nGenerate JWT secret for authentication\n```\nphp artisan jwt:secret\n```\nAdd these two lines to `.env` file\n```\n  BASE_API=/api\n  MIX_BASE_API=\"${BASE_API}\"\n```\n\n##### Publish vendor packages/assets\n```\nphp artisan vendor:publish --provider=\"Tuandm\\Laravue\\ServiceProvider\" --tag=\"laravue-core\"\nphp artisan vendor:publish --provider=\"Tuandm\\Laravue\\ServiceProvider\" --tag=\"laravue-asset\"\n```\n\n##### Add NPM dependencies\n```\nnpm add babel-plugin-syntax-dynamic-import babel-plugin-syntax-jsx babel-plugin-transform-vue-jsx eslint eslint-loader eslint-plugin-vue laravel-mix-eslint vue-template-compiler svg-sprite-loader --save-dev\n\nnpm add element-ui js-cookie normalize.css nprogress vuex vue-count-to vue-i18n vue-router \n\nnpm install # To make sure everything is set\n```\n\nPlease check [package.json sample](https://github.com/tuandm/laravue-core/tree/master/package.json.sample)\n\n##### Webpack.mix.js configuration\nWe need to modify the webpack.mix.js to work with Laravue package, please refer to [webpack.mix.js sample](https://github.com/tuandm/laravue-core/tree/master/webpack.mix.js.sample)\n\nOr simply run this command to generate recommendation version.\n\n```\nphp artisan laravue:webpack\n```\n\n##### Babel\nLaravue requires babel to build the packages. Usually, `.babelrc` will be generated with [laravue:setup command](#setup-laravue). Please manual add required plugins to `.babelrc` file if your project already uses it. Sample `.babelrc` can be found [here](https://github.com/tuandm/laravue-core/tree/master/.babelrc.sample)\n\n\n#### 2. Config API guard\nOpen `config/auth.php` and modify as below\n\n```\n    # Change default auth guard to api\n    'defaults' =\u003e [\n        'guard' =\u003e 'api',\n    ],\n    ...\n    # Use JWT driver for api guard\n    'guards' =\u003e [\n    ....\n    'api' =\u003e [\n        'driver' =\u003e 'jwt',\n    ....\n    \n    # Use Laravue User model to authenticate\n    'providers' =\u003e [\n        'users' =\u003e [\n            'driver' =\u003e 'eloquent',\n            'model' =\u003e Tuandm\\Laravue\\User::class,\n        ],\n``` \nPlease refer to [auth.php sample](https://github.com/tuandm/laravue-core/tree/master/src/config/auth.php.sample)\n\n#### 3. Database\nLaravue core requires `users.role` field, consider to run migration if neccessary\n\n```\nphp artisan migrate\n```\n\n#### 4. Sample data\nThis database seeder will insert 3 test users, you can ignore this step if you have data already.\n\n```\nphp artisan db:seed --class=Tuandm\\\\Laravue\\\\Database\\\\Seeds\\\\DatabaseSeeder\n```\n\n### Start development\n\n```\nnpm run dev # or npm run watch\n```\n\n### Build production\n\n```\nnpm run production\n```\n\n## Running the tests\n\n- Tests system is under development.\n\n## Built with\n* [Laravel](https://laravel.com/) - The PHP Framework For Web Artisans\n* [VueJS](https://vuejs.org/) - The Progressive JavaScript Framework\n* [Element](https://element.eleme.io/) - A  Vue 2.0 based component library for developers, designers and product managers\n* [Vue Admin Template](https://github.com/PanJiaChen/vue-admin-template) - A minimal vue admin template with Element UI\n\n## Contributing\n\nPlease read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.\n\n## Versioning\n\nWe use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/tuandm/laravue-core/tags). \n\n## Authors\n\n* **Tuan Duong** - *Initial work* - [tuandm](https://github.com/tuandm)\n\nSee also the list of [contributors](https://github.com/tuandm/laravue-core/contributors) who participated in this project.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details\n\n## Acknowledgements\n\n* [Laravue](https://laravue.dev) - A beautiful dashboard for Laravel built by VueJS and ElementUI\n* [vue-element-admin](https://panjiachen.github.io/vue-element-admin/#/) A magical vue admin which insprited Laravue project\n* [tui.editor](https://github.com/nhnent/tui.editor) - Markdown WYSIWYG Editor\n* [Echarts](http://echarts.apache.org/) - A powerful, interactive charting and visualization library for browser\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftuandm%2Flaravue-core","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftuandm%2Flaravue-core","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftuandm%2Flaravue-core/lists"}