Skip to content

Commit

Permalink
fix: 完善README
Browse files Browse the repository at this point in the history
  • Loading branch information
likai committed Oct 19, 2020
1 parent fa2e1a1 commit 4cbb475
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 19 deletions.
Binary file added JetBrains.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 23 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,34 @@
# chat-system-vue3
# chat-system
本项目是一个在线聊天系统,最大程度的还原了Mac客户端QQ。

## 前言
使用vue3+typescript将原项目进行重构,原项目地址:[chat-system](https://github.com/likaia/chat-system)
使用Vue3+TypeScript作为项目主体架构,有关项目的更多介绍以及重构过程请移步:[Vue模仿Mac版本QQ开源啦 | 掘金优秀开源推荐](https://juejin.im/post/6844904036177543176) & (使用Vue3重构vue2项目)[]

## Project setup
```
yarn install
```
## 项目启动
* 终端或命令行执行下述命令,将项目下载到本地
```bash
git clone https://github.com/likaia/chat-system.git
```
* 分别执行下述命令,进入项目根目录,安装依赖
```bash
cd chat-system

### Compiles and hot-reloads for development
yarn install
```
* 执行下述命令启动项目
```bash
yarn serve
```

### Compiles and minifies for production
```
## 项目开发
* 使用你喜欢的编辑器打开项目即可
* 在终端或命令行执行下述命令即可对项目进行打包
```bash
yarn build
```
## 写在最后
![](./JetBrains.png)

### Lints and fixes files
```
yarn lint
```

### Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/).
感谢 **[JetBrains](https://www.jetbrains.com/?from=chat-system)** 公司提供的的 **[软件开源许可证](https://www.jetbrains.com/shop/eform/opensource)**
* 项目遵守 [MIT](https://choosealicense.com/licenses/mit/) 开源协议
* 本项目仅用于学习使用,切勿用于商业用途,否则产生的法律后果与作者无关。
7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "chat-system-vue3",
"version": "0.1.0",
"name": "chat-system",
"version": "1.0.0",
"private": true,
"scripts": {
"serve": "vue-cli-service serve",
Expand Down Expand Up @@ -35,5 +35,6 @@
"prettier": "^1.19.1",
"sass-loader": "^8.0.2",
"typescript": "~3.9.3"
}
},
"license": "MIT"
}

0 comments on commit 4cbb475

Please sign in to comment.