forked from harry-xqb/rent-house
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.md
132 lines (78 loc) · 6.9 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
## Rent-House
前端源码: [https://github.com/night-233/rent-house-admin](https://github.com/night-233/rent-house-admin)
后端源码: [https://github.com/harry-xqb/rent-house](https://github.com/harry-xqb/rent-house)
项目致力于打造一个完整的租房系统，采用现阶段流行技术实现。
## **项目介绍**
rent-house 项目是一套模仿自如的租房系统，基于SpringBoot+Elasticsearch实现，采用Docker容器化部署。系统主要包含租房首页、房源搜索、房源展示、地图找房、房源周边检索、收藏栏、看房预约、用户中心、发布管理、账号管理等模块。
## 在线演示
(由于个人经费原因，在线网址已经停机，麻烦大家使用docker方式进行本地部署, 见下文)
租房网地址: [http://house.touchfish.top](http://house.touchfish.top) 账号: 17811111111 密码: 123
后端swiger接口地址: [http://house.frp.touchfish.top/swagger-ui.html](http://house.frp.touchfish.top/swagger-ui.html) 账号: admin 密码: 123
## 技术选型
#### 后端技术
| 技术 | 说明 | 官网 |
| -------------- | ---------------- | ------------------------------------------------------------ |
| SpringBoot | 容器+MVC框架 | https://spring.io/projects/spring-boot |
| SpringSecurity | 认证和授权框架 | [ https://spring.io/projects/spring-security](https://spring.io/projects/spring-security) |
| SpringDataJpa | ORM框架 | https://docs.spring.io/spring-data/jpa/docs/current/reference/html/ |
| Elasticsearch | 搜索引擎 | https://www.elastic.co/cn/ |
| Kibana | Elastic可视化 | https://www.elastic.co/cn/kibana |
| Swagger-UI | 文档生产工具 | https://github.com/swagger-api/swagger-ui |
| Redis | 分布式缓存 | https://redis.io/ |
| Docker | 应用容器引擎 | [https://www.docker.com](https://www.docker.com/) |
| Druid | 数据库连接池 | [ https://github.com/alibaba/druid](https://github.com/alibaba/druid) |
| Lombok | 简化对象封装工具 | [ https://github.com/rzwitserloot/lombok](https://github.com/rzwitserloot/lombok) |
| Mysql | 关系型数据库 | https://www.mysql.com/ |
| Kafka | 消息队列 | http://kafka.apache.org/ |
| Zookeeper | 注册中心 | https://zookeeper.apache.org/ |
#### 前端技术
| 技术 | 说明 | 官网 |
| ---------------------- | ---------------- | ------------------------------------------------------- |
| React Hook | 前端框架 | https://react.docschina.org/docs/hooks-intro.html |
| React Router | 路由框架 | https://reactrouter.com/ |
| Redux | 全局状态管理框架 | https://redux.js.org/ |
| TypeScript | JavaScript超集 | https://www.typescriptlang.org/ |
| Ant Design | 前端UI框架 | https://ant.design/index-cn |
| Nprogress | 进度条控件 | https://www.npmjs.com/package/nprogress |
| Swiper | 轮播滑动插件 | https://swiperjs.com/ |
| Axios | 前端HTTP框架 | https://www.axios.com/ |
| React-Sticky | 吸顶效果组件 | https://www.npmjs.com/package/react-sticky |
| React-Custom-Scrollbar | 自定义滚动条 | https://github.com/malte-wessel/react-custom-scrollbars |
### 快速开始
#### Docker-Compose一键部署
进入该项目下docker目录, 修改application.yml和docker-compose.yml 注释中带有 #***** [修改内容] ***** 号部分的配置为你的相关配置，修改完成后在docker目录下执行以下命令,
注意 docker-compose.yml下 kafka的KAFKA_ADVERTISED_HOST_NAME配置要改成你的主机ip地址
窗口运行: `docker-compose up`
后台运行: `docker-compose up -d`
停止: `docker-compose stop`
停止并移除: `docker-compose down`
查看日志: `docker-compose logs -f`
启动后即可访问租房网前端地址: [http://localhost:8888 ](http://localhost:8888 )
后端接口文档地址: [http://localhost:8080/swagger-ui.html ](http://localhost:8080/swagger-ui.html )
说明: 拉取镜像的过程可能比较慢，如果网络环境不好，不建议使用该方式。 另外不了解docker的同学需要先学习下Docker： [Docker官网](https://www.docker.com/)
#### 前端开发学习
对于想要学习前端的小伙伴， 只需以下几步即可启动前端项目
1. clone前端源码([前端源码]([https://github.com/night-233/rent-house-admin](https://github.com/night-233/rent-house-admin)))
2. 执行 yarn install
3. 执行 yarn start
项目启动后默认打开: [localhost:3000](localhost:3000) 端口。 后端接口默认连接的是我个人服务器(可能有点慢)，如果使用了上面的Docker部署了开发环境，可在config-override.js中修改IP的地址为本地。
默认接口文档地址: [http://rent-house.touchfish.top](http://rent-house.touchfish.top)
#### 项目二次开发
对于需要进行二次开发的同学，可以搭建一套自己的开发环境，相关数据表及索引如下
数据库表: rent-house/src/main/resources/db/rent-house.sql
elasticsearch索引: rent-house/src/main/resources/db/house_index__ik_mapping_suggestion.json (elastic需要安装ik分词器)
redis: 需要安装并配置application-dev.yml中 redis相关信息即可
kafka: 需要安装并配置application-dev.yml中 kafka相关信息
zookeeper: kafka注册中心
kibana: 方便管理与查看elasticsearch（可以不安装）
#### 技术问答
## <img src="http://qiniu.touchfish.top/qrcode.jpg" alt="qrcode" width="200" height="200"/>
## 天涯何处无芳草，给颗星星好不好┭┮﹏┭┮
## 项目界面展示
## 
