cubes-doo/laravel-skeleton-basic

Cubes Laravel 项目骨架:skeleton-basic

v0.7.7 2020-02-14 14:12 UTC

This package is auto-updated.

Last update: 2024-09-11 14:23:08 UTC


README

A Laravel入门项目,用于定义标准并快速启动🚀

用其他语言阅读此内容: Srpski, Српски

入门指南

以下说明将帮助您获取项目的副本,并帮助您在本地计算机上开发测试。有关如何在实时系统上部署项目的说明,请参阅部署

先决条件

  1. Composer
  2. Docker

安装

一系列逐步示例,将指导您如何运行开发环境。

首先,我们需要从 Packagist 拉取一个项目实例

composer create-project cubes-doo/laravel-skeleton-basic newProjectName

现在,如果您想使用 Docker,请首先从我们的 'docker-compose' git 仓库拉取 Docker 工具文件

git clone https://github.com/cubes-doo/docker-compose.git docker

接下来,让我们将 docker/.env.example 复制到新的 docker/.env 文件

cp docker/.env.example docker/.env

现在,让我们来做些更令人兴奋的事情 😁,让我们启动我们的 Docker 容器!

sudo docker/docker-start.sh

由于不同机器上的 UID 可能存在差异,因此让我们运行

cd docker ; ./docker-usermod.sh ; cd ../

以防万一。对此的简要解释是:使用此命令确保您具有与 Docker Shell 中的用户相同的权限,就像在您的机器上一样。

现在我们可以运行

sudo docker/docker-console.sh

进入 Docker 容器的 shell,然后在其中运行

composer install

在根目录下的 .env 文件中检查 APP_KEY 是否有值(例如:'APP_KEY=base64:Q1teAHYgmZtZ5ZFD1CJZp8yzlQuBqUeXsz3Mn++/yl3='),如果没有,也运行

php artisan key:generate

为了创建和填充您的本地数据库以测试数据,您应该运行

php artisan migrate --seed

然后您就可以开始了!

在此项目上使用的 主题Coderthemes 开发,不是免费的。所以,至少在视觉上,没有付费许可证,这个项目对您来说就没有用了。如果您是我们 Cubes 的同事,请在 public/ 文件夹中定位自己

cd public

然后按照以下方式从其 Gitlab 仓库克隆它

git clone git@gitlab.cubes.rs:web/laravel-skeleton-theme.git theme

继续,登录并探索!默认情况下,项目暴露在 https://:7737。如果您不希望这样,请参阅 docker/.env.env 文件进行更改。

运行代码检查

目前我们只使用 FriendsOfPHP/PHP-CS-Fixer 作为 composer 依赖项。您可以在 .php_cs 中找到规则集。

还有一些值得注意的命令,可以让代码检查变得简单

sudo docker/docker-php-cs-check.sh

进行 dry-run 的 php-cs-fixer,只告诉您应该更改什么

sudo docker/docker-php-cs-fix.sh

使用 php-cs-fixer 实际上修复代码

运行测试

我们创建了一个脚本,该脚本在 Docker 容器内运行测试

sudo docker/docker-unit-test-run.sh

此脚本将运行 tests/ 文件夹中公开的所有测试。

部署

添加有关如何在实时系统上部署此项目的附加说明

阅读材料

构建于

版本控制

我们使用SemVer进行版本控制。有关可用的版本,请参阅此存储库上的标签

作者

有关参与此项目的贡献者列表也请参阅。