eleazarbr/project-skeleton

我项目的基模板。

v1.0.0 2023-01-29 16:55 UTC

This package is auto-updated.

Last update: 2024-09-24 23:41:32 UTC


README

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

项目骨架

所有项目的基模板。

报告错误 · 请求功能

目录
    ```
  1. 关于项目
  2. 入门
  3. 用法
  4. 路线图
  5. 贡献
  6. 许可证
  7. 联系方式
  8. ```

关于项目

Project Skeleton Screen Shot

此存储库提供了一个预配置的模板,其中包含基本工具,用于启动任何项目。

(返回顶部)

使用工具

  • Laravel
  • Vue
  • Vite
  • Bulma
  • Tailwind CSS
  • Inertia
  • Oruga

(返回顶部)

入门

按照以下步骤获取本地副本并运行

先决条件

未来,将提供Docker或Laravel Sail的选项。目前,安装需要像NGINX这样的Web服务器以及以下工具

安装

要创建新项目,请执行以下操作

composer create-project eleazarbr/project-skeleton name

安装JavaScript依赖项

npm install

编译资产

npm run dev

接下来,设置您的.env文件。基本配置包括

  • 应用名称和URL。
  • 数据库连接和迁移:php artisan migrate
  • 邮件设置(例如:Mailtrap)。
  • 执行:php artisan storage:link

现在,您应该可以通过浏览器访问项目。

用法

项目集成了Laravel和Vue的长版本。此外,还包括代码修复器和检查器,以确保保持编码标准。以下是简要说明

  • 应用rector.php文件中的规则:composer rector
  • 修复PHP代码:composer php-cs-fixer。(将来将使用Laravel Pint)
  • 运行检查器(可选):composer php-md
  • 修复JavaScript代码:npm run lint-fix
  • 使用Prettier格式化JavaScript代码:npm run format
  • 测试整个套件:php artisan test

浏览器测试:

  • 安装Laravel Dusk:php artisan dusk:install
  • 运行测试:php artisan dusk

(返回顶部)

路线图

  • 实现Bulma CSS
  • 添加i18n。
  • 用Laravel Pint替换PHP CS Fixer
  • 添加Docker/Laravel Sail支持。

有关建议功能和已知问题的完整列表,请访问开放问题

(返回顶部)

贡献

您的贡献有助于使开源社区成为学习、灵感和创造力的空间。任何贡献都将受到高度重视。

如果您有任何改进建议,请将存储库分叉并创建一个拉取请求或打开一个标记为“改进”的问题。别忘了给项目加星!

  1. 分叉项目
  2. 创建您的功能分支(git checkout -b feature/amazing-feature
  3. 提交您的更改 (git commit -m '添加一些惊人的功能')
  4. 推送到分支 (git push origin feature/amazing-feature)
  5. 打开一个拉取请求

(返回顶部)

许可证

本项目采用MIT许可证分发。更多信息,请参阅LICENSE.txt文件。

(返回顶部)

联系方式

Eleazar Resendez - @eleazarbr - eleazar@eresendez.com

项目链接: https://github.com/eleazarbr/project-skeleton

(返回顶部)