如何组织我的 laravel 项目的 github 存储库,以便用户可以轻松安装和 运行 它?

How can I organize my laravel project's github repository so that users can easily install and run it?

五个月前,我创建了一个相当广泛的 Laravel 博客管理系统。我现在正处于找工作的阶段,希望潜在的雇主能够轻松安装并 运行 我的项目来检查它。我想在 readme.md 中包含有关如何开始使用它的说明,但我刚刚意识到我自己无法弄清楚如何 运行 它!

这里是存储库:https://github.com/colesam/Laravel-Blog

这是我试过的方法:

git clone git@github.com:colesam/Laravel-Blog.git
composer install
php artisan serve

这将 repo 复制到我的 xampp/htdocs 目录和 运行 中。 XAMPP 当前 运行 MySQL 和 Apache 运行ning.

控制台通过告诉我它正在 localhost:8000 上进行响应来响应。不幸的是,我收到关于实际 html 文档的错误消息:

我的项目出了什么问题,我怎样才能让我的潜在雇主/任何想下载和检查我的项目的人尽可能轻松地解决这个问题?

其实很简单。大约需要 5 分钟。以下是步骤:

  1. 克隆项目
  2. 创建数据库
  3. .env.example 复制到 .env 并设置正确的数据库凭据
  4. 运行 php artisan key:generate 生成应用密钥
  5. 运行 php artisan migrate 创建表格
  6. 运行 php artisan serve

大功告成。