提交 74efc8f1 作者: 方治民

docs: 更新 README

上级 37f7aaa5
# 使用 Puppeteer 官方镜像作为基础镜像(基于 Node 镜像构建) # 使用 pm2 镜像,包含 node npm yarn
FROM keymetrics/pm2:16-alpine FROM keymetrics/pm2:16-alpine
# 设置工作目录 # 设置工作目录
......
[![Actions Status](https://github.com/jingsam/foxgis-server-lite/workflows/Node%20CI/badge.svg)](https://github.com/jingsam/foxgis-server-lite/actions)
# FoxGIS Server Lite # FoxGIS Server Lite
> 一款简单易用的矢量瓦片地图服务软件。 > 一款简单易用的矢量瓦片地图服务软件。
...@@ -8,7 +6,6 @@ ...@@ -8,7 +6,6 @@
请查看[帮助文档](https://jingsam.github.io/foxgis-server-lite/#/) 请查看[帮助文档](https://jingsam.github.io/foxgis-server-lite/#/)
## 快速开始 ## 快速开始
将系统代码克隆下来后,相关命令如下: 将系统代码克隆下来后,相关命令如下:
...@@ -26,10 +23,35 @@ yarn dist // 打包为二进制文件 ...@@ -26,10 +23,35 @@ yarn dist // 打包为二进制文件
yarn docs // 打开文档 yarn docs // 打开文档
``` ```
## Docker 构建
> 注意把项目中的 [data](./data/) 目录拷贝的运行环境,用于挂载模板文件 (同时还可以在特殊情况下挂载 bin 和 app 目录,方式同 data 挂载)
```bash
# 安装并启动 docker ...
# 构建
docker build -t foxgis-server-lite .
# 查询构建的 image id
docker images
# 挂载当前目录的 data 作为模板文件夹,并启动容器
docker run -d -p 1234:1234 -v $PWD/data:/usr/src/app/data foxgis-server-lite
# 停止容器
docker stop <container id>
# 导出镜像
docker save -o foxgis-server-lite.tar foxgis-server-lite
# 导入镜像
docker load -i foxgis-server-lite.tar
# 查询刚刚导入的镜像
docker images
# 添加 tag
docker tag <image id> foxgis-server-lite:latest
```
## 项目结构 ## 项目结构
本项目基于Express搭建,并对Express默认的目录结构做了更改。Express默认的目录结构是按照Model、View、Controller组织代码,本项目则是按照服务组织代码。每个服务分配一个目录,每个服务目录下再按照MVC划分文件,各服务间尽量进行代码隔离、数据隔离,便于以后改造为微服务。 本项目基于 Express 搭建,并对 Express 默认的目录结构做了更改。Express 默认的目录结构是按照 Model、View、Controller 组织代码,本项目则是按照服务组织代码。每个服务分配一个目录,每个服务目录下再按照 MVC 划分文件,各服务间尽量进行代码隔离、数据隔离,便于以后改造为微服务。
本项目的主要代码结构如下,主要的代码逻辑在`app`目录: 本项目的主要代码结构如下,主要的代码逻辑在`app`目录:
...@@ -52,4 +74,3 @@ yarn docs // 打开文档 ...@@ -52,4 +74,3 @@ yarn docs // 打开文档
|-- docs/ // 文档目录 |-- docs/ // 文档目录
|-- test/ // 测试文件 |-- test/ // 测试文件
``` ```
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论