docs: 完成文档

This commit is contained in:
daodao97
2020-06-17 07:49:45 +08:00
parent 8d89932c98
commit 90849f8eea
2 changed files with 89 additions and 58 deletions

View File

@@ -1,12 +1,10 @@
?> `hyperf-admin`目前尚未开源, 敬请期待.
## 前端
```shell
# 环境依赖
# 1. node ^v11.2.0 https://nodejs.org/zh-cn/download/
# 2. npm ^6.4.1
git clone https://github.com/hyperf-admin/hyperf-admin-front.git
git clone https://github.com/hyperf-admin/hyperf-admin-frontend.git
cd hyperf-admin-front
npm i
npm run dev
@@ -24,16 +22,49 @@ npm run build:test
```shell
# 环境依赖 php ^7.1 composer swoole
# 下载demo项目
git clone https://github.com/hyperf-admin/hyperf-admin-skeleton.git
cd hyperf-admin-skeleton
composer create-project hyperf/hyperf-skeleton hyperf-admin
cd hyperf-admin
# hyperf-admin 为分包的模式, 此处引入的是完整厂库, 实际项目请按需引入
composer require hyperf-admin/hyperf-admin
composer i
# 启动
# 启动 热重启参考 https://github.com/daodao97/hyperf-watch
composer watch
```
## nginx配置
```nginx
# conf
upstream backend {
server 127.0.0.1:9511;
}
server {
listen 80;
server_name hyperf-admin.com;
index index.html;
root /opt/www/rock-admin-front/dist;
access_log /usr/local/var/log/nginx/hyperf-admin.access.log;
error_log /usr/local/var/log/nginx/hyperf-admin.error.log;
location ~ /api/(.*) {
proxy_http_version 1.1;
proxy_set_header Connection "keep-alive";
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header Host hyperf-admin.com;
proxy_pass http://backend/$1$is_args$args;
}
location / {
root /opt/www/rock-admin-front/dist/default;
index index.html;
}
location ~ /(.*) {
set $module $1;
if ($module ~* '^$') {
set $module default;
}
try_files $uri $uri/ /$module/index.html;
}
}
```