envor/one-app

基于 Laravel Jetstream 和 Livewire 的 Laravel 团队数据库入门套件


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

基于 Laravel Jetstream 和 Livewire 的 Laravel 团队数据库入门套件

安装

首先设置一个新的 Laravel 应用

使用 Laravel 安装器

laravel new one-app

或者使用 Composer

composer create-project "laravel/laravel:^11.0" one-app
cd one-app

然后您可以通过 Composer 安装此包

composer require envor/one-app
php artisan one-app:install

要配置您的平台数据库(即 centrallandlord 数据库等)

将以下密钥添加到您的 .env 文件中

PLATFORM_DB_CONNECTION=sqlite

注意

如果您使用的是 sqlite 以外的连接,您必须确保已配置连接的凭据

接下来,使用 database/migration/platform 路径和您的 PLATFORM_DB_CONNECTION 名称刷新您的迁移

php artisan migrate:fresh --path=database/migrations/platform --database=sqlite

现在您可以测试应用程序以确保一切正常工作!

php artisan test

SSO(可选)

如果需要,您可以将 one-app 设置为使用 laravel/passport 而不是 laravel/sanctum,这将包含一个完整的 OAuth2 服务器,包括自助令牌和客户端管理 UI。

首先按照上述步骤安装 one-app。

然后安装 headerx/laravel-jetstream-passport

composer require headerx/laravel-jetstream-passport:^1.0

重要

在设置 one-app 时,不要运行来自 headerx/laravel-jetstream-passportjetstream-passport:install 命令!one-app 有它自己的安装 passport 的命令(如下所示)。

然后运行 one-app:passport 命令

php artisan one-app:passport

然后运行迁移

php artisan migrate --path="database/migrations/platform" --database="sqlite"

然后再次运行测试!

测试

php artisan test

composer test

开发

此工具会安装一些东西。在开发过程中,占位符需要经过测试。以下是如何进行测试的说明。

要求

1. 在空目录中设置 Laravel 环境

composer create-project laravel/laravel:11.x-dev .
composer require laravel/jetstream:@dev --no-interaction --no-update
composer require envor/one-app:@dev --no-interaction --no-update
composer config repositories.one-app '{"type": "path", "url": "one-app"}' --file composer.json
echo "PLATFORM_DB_CONNECTION=sqlite" >> .env
echo "one-app/" >> .gitignore
git add . && git commit -m "setup testing environment"

2. 克隆仓库

SSH

git clone git@github.com:envor/one-app.git

HTTPS

git clone https://github.com/envor/one-app.git

3. 安装依赖项(在根工作目录中,而不是 one-app)

composer update "laravel/jetstream" --prefer-dist --no-interaction --no-progress -W

4. 安装 one-app(在根工作目录中,而不是 one-app)

composer update "envor/one-app" --prefer-dist --no-interaction --no-progress -W
php artisan one-app:install -v

5. 安装 npm 依赖项(在根工作目录中,而不是 one-app)

npm install

6. 编译资产(在根工作目录中,而不是 one-app)

npm run build

7. 执行测试(在根工作目录中,而不是 one-app)

php artisan test

8. 如果您没有问题,您就可以开始了。现在您可以将环境重置以开始进行更改。

git reset --hard && git clean -df
composer install

9. 进行更改

编辑 one-app/ 目录中的文件

10. 通过重复步骤 3-7 来测试您的更改。

11. 重复步骤 8-10

12. 根据需要重复步骤 11

变更日志

请参阅 CHANGELOG 了解最近更改的更多信息。

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全漏洞

请参阅我们关于如何报告安全漏洞的安全策略 我们的安全策略

鸣谢

许可证

麻省理工学院许可证(MIT)。有关更多信息,请参阅许可文件