Skip to content

Commit

Permalink
📝 docs: 完善README
Browse files Browse the repository at this point in the history
  • Loading branch information
Reaper622 committed Sep 24, 2019
1 parent e170bde commit 6ebb7de
Showing 1 changed file with 42 additions and 1 deletion.
43 changes: 42 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# TheBlog
A system to build your own blog site.

修改一个配置文件,即可搭建出你自己的博客平台。



### 使用环境

- node >= v8
- mysql
- npm



### 如何使用?
Expand All @@ -17,5 +27,36 @@ git clone [email protected]:Reaper622/TheBlog.git
npm install
```

-
- 执行初始化命令

```
npm run init
```

- 根据`config.sample.js`完成对 MySQL数据库的配置,完成后修改文件名为`config.js`
- 修改`config.json`内部分自定义设置
-`articles`文件夹下创建文档目录

```
articles/
|-- label 标签
|-- year 年份
|-- month 月份
|-- day 日期
|-- filename 文件
```

- 执行打包命令

```
npm run build
```

- 执行服务端运行指令

```
npm run server
```

- 访问 [localhost:4000](locahost:4000) 即可访问

0 comments on commit 6ebb7de

Please sign in to comment.