From e6761f491c17efb6f4c5a290570c9c211af2bfe4 Mon Sep 17 00:00:00 2001 From: sa0ChunLuyu Date: Wed, 23 Aug 2023 22:39:59 +0800 Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 1 + README.md | 72 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 73 insertions(+) create mode 100644 .gitignore create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..485dee6 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.idea diff --git a/README.md b/README.md new file mode 100644 index 0000000..269b8fa --- /dev/null +++ b/README.md @@ -0,0 +1,72 @@ +# 入魔入佛 + +入魔入佛是一个基于 Laravel 10、Vue 3 和 Layui-vue 的项目初始模板,灵感来自于 Linux 命令 `rm -rf`。该模板旨在帮助开发者快速搭建现代化的 Web 应用程序。 + +## 功能特点 + +- 使用 Laravel 10 提供强大的后端功能和安全性。 +- 使用 Vue 3 构建现代化的前端用户界面。 +- 使用 Layui-vue 提供美观、简洁的 UI 组件。 +- 集成了常用的开发工具和插件,提高开发效率。 +- 遵循最佳实践和编码规范,提供可维护和可扩展的代码结构。 + +## 快速开始 + +### 安装依赖 + +在项目根目录下,执行以下命令来安装所需的依赖: + +```shell +cd api && composer install +cd admin && pnpm install +``` + +### 配置环境变量 + +复制 `.env.example` 文件并重命名为 `.env`,然后根据实际情况配置其中的环境变量。 + +### 数据库迁移 + +运行数据库迁移命令来创建数据库表: + +```shell +php artisan migrate +``` + +### 编译前端资源 + +使用以下命令编译前端资源: + +```shell +cd admin && rm -rf ../api/public/rmrf && pnpm build +``` + +### 启动服务 + +运行以下命令启动 Laravel 和后台项目开始开发: + +```shell +cd admin && pnpm dev +cd api && php artisan serve --host 0.0.0.0 +``` + +现在,您可以在浏览器中访问 `http://localhost:3333/rmrf` 来查看后台应用程序。 + +而接口在 `http://localhost:8000` 访问。 + + +## 贡献指南 + +如果您发现任何问题或有改进建议,请随时提出 issue 或提交 pull 请求。我们欢迎您的贡献! + +## 许可证 + +入魔入佛使用 [MIT 许可证](https://opensource.org/licenses/MIT)。请查阅 LICENSE 文件了解更多详情。 + +## 联系我们 + +如果您有任何疑问或需要进一步的帮助,请联系我们:[sa0Chun_luyu@aliyun.com](mailto:sa0Chun_luyu@aliyun.com)。感谢您的支持! + +--- + +请注意,入魔入佛仅作为一个项目初始模板,您可以根据自己的需求进行修改和扩展。希望这个模板能够帮助您快速启动项目并提供良好的开发体验!