快速构建 RESTful API 以及现代化 Web 应用的 Laravel 原型项目 —— Someline

1、简介

Someline Starter 是一个以现代设计模式为基础，用于快速构建 Web App 和RESTful API 的 PHP 框架，基于Laravel 5、Vue.js、RESTful API、Repository设计、OAuth 2、JWT、单元测试等前端和后端技术，充满潮流感和现代感。

Someline Starter 的诞生原因有二：

• 快速构建应用或 RESTful API，而不必使用 Laravel 从头开始开发；
• 引入现代设计模式，以便让 PHP 项目有着更高的起点、更好的基础。

演示站点： https://starter.someline.com/login （libern@someline.com/Abc12345）

Github仓库： https://github.com/someline/someline-starter

视频教程： https://youtu.be/6_lxJNX0Qe0

2、概览

• Someline Starter 适配面向 RESTful API 的项目。
• RESTful API 作为后端服务层，可以为 Web 前端和移动 App 提供统一的接口。
• 使用 LaravelPassport 对受保护资源进行认证。
• 还为 API 和框架提供了单元测试。
• 使用了Angulr 主题。
• 完全使用 Repository 设计模式。

3、开箱提供的组件

框架

• Laravel 5.3： laravel/framework
• Laravel IDE 助手： barryvdh/laravel-ide-helper （ 中文教程 ）
• Clockwork： itsgoingd/clockwork （ 中文教程 ）
• Laravel 5 日志查看器： rap2hpoutre/laravel-log-viewer

底层

• Redis： predis/predis
• GuzzleHTTP： guzzlehttp/guzzle
• HTTP状态： lukasoppermann/http-status

核心

• RESTful API： dingo/api （ 中文教程 ）
• L5 Repository： prettus/l5-repository
• Fractal： thephpleague/fractal
• Laravel 验证： prettus/laravel-validation
• Intervention Image： intervention/image （ 中文教程 ）
• Intervention Image Cache： intervention/imagecache
• Image Validator： cviebrock/image-validator
• Rest API 客户端： someline/rest-api-client
• Someline Image Service： someline/someline-image

认证

• Laravel Passport： laravel/passport （ 中文教程 ）

主题

• Angulr 主题，基于Bootstrap和jQuery。演示地址： Angulr版本 和 HTML版本 。

前端

• Vue.js： Vue.js

4、入门

注：正式开始之前，确保你已经安装了 PHP 7.0 和 Composer。

以下是两种可选安装方案：

通过Composer安装

在 web 根目录下运行如下命令：

composer create-project --prefer-dist someline/someline-starter someline-starter

通过克隆Github仓库代码安装

同样，在 web 根目录下运行如下命令：

git clone https://github.com/someline/someline-starter

将代码库替换成你自己的库

如果需要的话，你可以将 Someline Starter 代码库替换成你自己的 github 仓库地址（假设是 https://github.com/username/repository-name.git ）：

cd someline-starter
rm -rf .git

git init
git add .
git commit -m 'Initial commit'

git remote add origin https://github.com/username/repository-name.git
git push -u origin master

5、安装

系统要求

• PHP：>=7.0
• MySQL：>= 5.7
• SQLite扩展
• Laravel 5：安装文档
• NodeJS： https://nodejs.org/
• Bower： https://bower.io/

安装要点

首先进入项目根目录：

cd someline-starter

安装项目依赖（通过 git clone 方式安装项目的话）：

composer install

安装npm依赖：

npm install

安装bower依赖：

bower install

安装完成后，设置 Laravel：

sudo cp .env.example .env
sudo chmod -R 777 storage
sudo chmod -R 777 bootstrap/cache
php artisan key:generate

数据库 & 数据填充

首先需要创建一个新的数据库，例如 someline_starter ：

CREATE DATABASE `someline_starter` DEFAULT CHARACTER SET = `utf8mb4` DEFAULT COLLATE = `utf8mb4_unicode_ci`;

修改 .env 文件中数据的相关信息。

配置好数据库之后，进行迁移和数据填充：

php artisan migrate
php artisan db:seed

然后安装 Laravel Passport 来生成安全访问令牌：

php artisan passport:install

准备启程

到了这里，就可以访问首页了。

例如，假如你设置的域名是 http://someline-starter.app/ ，在浏览器中访问 http://someline-starter.app/ ，如果需要登录的话，账户和密码如下：

libern@someline.com
Abc12345

当然，你也可以在数据填充文件 database/seeds/UsersTableSeeder.php 中修改默认的账户信息。

接下来，Enjoy it 吧。

6、相关推荐

为了更好的使用 Someline，我们推荐你阅读并理解以下知识点：

• Laravel文档
• RESTful API最佳实践
• dingo api 指南
• Repository设计模式
• Repository的使用
• Vue.js指南

我们推荐你使用PHPStorm作为开发工具进行开发。