1 Star 0 Fork 0

kothing / laravel-costar

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Laravel Costar

A website navigation management system developed based on Laravel

Laravel Costar is a simple starter CMS based on Laravel 10.x. Most of the commonly needed features of an application like Authentication, Authorisation, User and Role management, Application Backend, Backup, Log viewer are available here. It is modular, so you may use this project as a base and build your own modules. A module can be used in any Laravel Costar based projects.

Screenshots

preview Image

preview Image

preview Image

Core Features

  • User Authentication

  • User Profile with Avatar

    • Separate User Profile table
  • Role-Permissions for Users

  • Dynamic Menu System

  • Language Switcher

  • Localization enabled across the project

  • Backend Theme

    • Bootstrap 5, CoreUI
    • Fontawesome 6
  • Frontend Theme

    • Tailwind
    • Fontawesome 6
  • Page Module

  • Article Module

    • Posts
    • Categories
    • Tags
    • Comments
    • wysiwyg editor
    • File browser
  • Application Settings

  • External Libraries

    • Bootstrap 5
    • Fontawesome 6
    • CoreUI
    • Tailwind
    • Datatables
    • Select2
    • Date Time Picker
  • Backup (Source, Files, Database as Zip)

  • Log Viewer

  • Notification

    • Dashboard and details view

How to start

Server Requirements

  • PHP >= 8.1
  • Mysql >= 5.7.8
  • BCMath PHP Extension
  • Ctype PHP Extension
  • DOM PHP Extension
  • Fileinfo PHP Extension
  • JSON PHP Extension
  • Mbstring PHP Extension
  • OpenSSL PHP Extension
  • PCRE PHP Extension
  • PDO PHP Extension
  • Tokenizer PHP Extension
  • XML PHP Extension

Web UI Installation

This laravel-cms-stater allows users who don't use Composer, SSH etc to install your application just by following the setup wizard. The current features are :

  • Check For Server Requirements.
  • Check For Folders Permissions.
  • Ability to set database information.
    • env text editor
    • env form wizard
  • Migrate The Database.
  • Seed The Tables.
  1. Clone or download the repository
  2. Go to the project directory and run composer install
  3. visit http://your-site.domain/install

Classic Installation

Follow the steps mentioned below to install and run the project. You may find more details about the installation in Installation Wiki.

  1. Clone or download the repository
  2. Go to the project directory and run composer install
  3. Create .env file by copying the .env.example. You may use the command to do that cp .env.example .env
  4. Update the database name and credentials in .env file
  5. Run the command to generate application key php artisan key:generate
  6. Run the command php artisan migrate --seed
  7. Link storage directory: php artisan storage:link
  8. You may create a virtualhost entry to access the application or run php artisan serve from the project root and visit http://127.0.0.1:8000

After creating the new permissions use the following commands to update cashed permissions.

php artisan cache:forget spatie.permission.cache

Docker and Laravel Sail

This project is configured with Laravel Sail (https://laravel.com/docs/sail). You can use all the docker functionalities here. To install using docker and sail:

  1. Clone or download the repository
  2. Go to the project directory and run composer install
  3. Create .env file by copying the .env-sail. You may use the command to do that cp .env-sail .env
  4. Update the database name and credentials in .env file
  5. Run the command sail up (consider adding this to your alias: alias sail='[ -f sail ] && sh sail || sh vendor/bin/sail')
  6. Run the command sail artisan migrate --seed
  7. Link storage directory: sail artisan storage:link
  8. Since Sail is already up, you can just visit http://localhost:80

Icons

FontAwesome & CoreUI Icons, two different font icon library is installed for the Backend theme and only FontAwesome for the Frontend. For both of the cases, we used the free version. You may install the pro version separately for your project.

admin dashborad login

Login Now by giving this data http://your-site-domain.com/admin

Username: super@admin.com
Password: password

Username: admin@admin.com
Password: password

Username: manager@manager.com
Password: password

Username: executive@executive.com
Password: password

Username: user@user.com
Password: password

You can find it in database/seeders/Auth/UserTableSeeder.php

Role - Permissions

Several custom commands are available to add and update role-permissions. Please read the Role - Permission Wiki page, where you will find the list of commands with examples.

Demo Data

If you want to test the application on your local machine with additional demo data you may use the following command.

php artisan costar:insert-demo-data --fresh

There are options to truncate the posts, categories, tags, and comments tables and insert new demo data.

--fresh option will truncate the tables, without this command new set of data will be inserted.


php artisan costar:insert-demo-data --fresh

Custom Commands

We have created a number of custom commands for the project. The commands are listed below with a brief about their use of it.

Clear All Cache

composer clear-all

this is a shortcut command clear all cache including config, route, and more

Code Style Fix

We are now using Laravel Pint to make the code style stays clean and consistent as the Laravel Framework. Use the following command to apply CS-Fix.

composer pint

Module Manager & Generator

Create New module

To create a project use the following command, you have repalce the MODULE_NAME with the name of the module.

php artisan module:build MODULE_NAME

You may want to use --force option to overwrite the existing module. if you use this option, it will replace all the exisitng files with the defalut stub files.

php artisan module:build MODULE_NAME --force

After creating the new moudle use the following commands to to run your database migrations.

php artisan migrate

Testing

composer test
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

Website navigation system base laravel-cms-starter 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
PHP
1
https://gitee.com/kothing/laravel-costar.git
git@gitee.com:kothing/laravel-costar.git
kothing
laravel-costar
laravel-costar
master

搜索帮助