docs: runing with docker compose (#8)

jinganix · Jan 28, 2024 · b233839 · b233839
1 parent ddfb828
commit b233839
Show file tree

Hide file tree

Showing 11 changed files with 157 additions and 31 deletions.
diff --git a/README.en.md b/README.en.md
@@ -3,38 +3,67 @@
 
 # Guess
 
-The source code of the 'Guess Who I Am' Wechat miniprogram
+The source code of the 'Guess Who I Am' Wechat miniprogram.
 
-## Run
+- Frontend development using `TypeScript` with `webpack` for building and bundling
+- Backend development using `Java` and `Spring` framework with `Gradle` for building and packaging
 
-### Backend
+## Running the Project
 
-#### Linux or MacOS
+To run the project, you need to first clone the source code and navigate to the project's root directory.
 
 ```shell
 git clone git@github.com:jinganix/guess.git
-cd guess/service/guess
-./gradlew service:guess:bootRun --args='--core.weapp.app-id=? --core.weapp.app-secret=? --core.url.db-mysql=? --spring.datasource.username=? --spring.datasource.password=?'
+cd guess
+```
+
+### Backend
+
+#### Running with docker-compose
+
+- Modify the [application-local.yml](service/guess/src/main/resources/application-local.yml) file to configure the backend service of the project
+
+- core.weapp.app-id: The `app-id` of the WeChat mini-program
+- core.weapp.app-secret: The `app-secret` of the WeChat mini-program
+
+If you have `docker` and `docker-compose` installed, you can start the backend service using the following command:
+
+```shell
+docker-compose up
 ```
 
-#### Windows
+#### Running with Gradle
 
-Replace `./gradlew` with `./gradlew.bat`
+You need to install JDK with the corresponding version specified in [.tool-versions](.tool-versions) and start a MySQL database.
 
-#### Description
+Modify the application-local.yml file to configure the backend services of the project.
 
-- core.weapp.app-id: `app-id` of the Wechat miniprogram
-- core.weapp.app-secret: `app-secret` of the Wechat miniprogram
-- core.url.db-mysql： Mysql connection url，e.g. `jdbc:mysql://127.0.0.1:3306/guess`
-- spring.datasource.username: Mysql connection username
-- spring.datasource.password: Mysql connection password
+- core.weapp.app-id: The `app-id` of the WeChat mini-program
+- core.weapp.app-secret: The `app-secret` of the WeChat mini-program
+- core.url.db-mysql: The connection URL of the MySQL database, e.g., `jdbc:mysql://127.0.0.1:3306/guess`
+- spring.datasource.username: The database username
+- spring.datasource.password: The database password
+
+The following command can be used to start the backend services on a Linux or macOS system:
+
+```shell
+./gradlew service:guess:bootRun'
+```
+
+The following command can be used to start the backend services on a Windows system:
+
+```shell
+./gradlew.bat service:guess:bootRun'
+```
 
 ### Frontend
 
-#### Execute commands
+You need to install [node.js](https://nodejs.org/en) with the version specified in [.tool-versions](.tool-versions).
+
+#### Running the Commands
 
 ```shell
-git@github.com:jinganix/guess.git
+git clone git@github.com:jinganix/guess.git
 cd guess/frontend/weapp
 npm install
 npm start
@@ -45,7 +74,7 @@ npm start
 1. Import`guess/frontend/weapp/dist` into Wechat devtools
 2. Disable domain verification
 
-   <img src="docs/devtools.setting.png" alt="Image" width="381" height="576">
+   <img src="docs/devtools.setting.en.png" alt="Image" width="381" height="576">
 
 ## Scan to experience
 

diff --git a/README.md b/README.md
@@ -1,42 +1,69 @@
 [![CI](https://github.com/jinganix/guess/actions/workflows/ci.yml/badge.svg)](https://github.com/jinganix/guess/actions/workflows/ci.yml)
 [![License](http://img.shields.io/:license-apache-brightgreen.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
 
-[English Doc](README.en.md)
-
 # 猜我是谁
 
 `猜我是谁`微信小程序源码
 
+- 前端使用`Typescript`开发，用`webpack`构建打包
+- 后端使用`Java`和`Spring`框架开发，用`gradle`构建打包
+
 ## 运行项目
 
+你需要先拉取项目源码，然后切换到项目根目录
+
+```shell
+git clone git@github.com:jinganix/guess.git
+cd guess
+```
+
 ### 后端
 
-#### Linux和MacOS
+#### 通过docker-compose运行
+
+修改[application-local.yml](service/guess/src/main/resources/application-local.yml)以运行项目后端服务
+
+- core.weapp.app-id: 微信小程序的`app-id`
+- core.weapp.app-secret: 微信小程序的`app-secret`
+
+如果你已经安装`docker`和`docker-compose`，可以通过以下命令启动后端服务
 
 ```shell
-git clone git@github.com:jinganix/guess.git
-cd guess/service/guess
-./gradlew service:guess:bootRun --args='--core.weapp.app-id=? --core.weapp.app-secret=? --core.url.db-mysql=? --spring.datasource.username=? --spring.datasource.password=?'
+docker-compose up
 ```
 
-#### Windows
+#### 通过gradle运行
 
-使用`./gradlew.bat`代替`./gradlew`
+你需要安装jdk，对应的版本在[.tool-versions](.tool-versions)，并启动mysql数据库
 
-#### 参数说明
+修改[application-local.yml](service/guess/src/main/resources/application-local.yml)以运行项目后端服务
 
 - core.weapp.app-id: 微信小程序的`app-id`
 - core.weapp.app-secret: 微信小程序的`app-secret`
 - core.url.db-mysql: mysql数据库连接地址，如`jdbc:mysql://127.0.0.1:3306/guess`
 - spring.datasource.username: 数据库用户名
 - spring.datasource.password: 数据库密码
 
+以下命令可以在`Linux`或`MacOd`系统中启动后端服务
+
+```shell
+./gradlew service:guess:bootRun'
+```
+
+以下命令可以在`Windows`系统中启动后端服务
+
+```shell
+./gradlew.bat service:guess:bootRun'
+```
+
 ### 前端
 
+你需要安装[node.js](https://nodejs.org/en)，对应的版本在[.tool-versions](.tool-versions)
+
 #### 运行命令
 
 ```shell
-git@github.com:jinganix/guess.git
+git clone git@github.com:jinganix/guess.git
 cd guess/frontend/weapp
 npm install
 npm start
@@ -55,4 +82,4 @@ npm start
 
 ## 贡献
 
-如果您有兴趣报告/修复问题并直接为代码库做出贡献，请查看 [CONTRIBUTING.md](CONTRIBUTING.md) 获取更多信息，了解我们期望的贡献内容以及如何开始。
+如果你有兴趣报告/修复问题并直接为代码库做出贡献，请查看 [CONTRIBUTING.md](CONTRIBUTING.md) 获取更多信息，了解我们期望的贡献内容以及如何开始。
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,34 @@
+version: "3.1"
+services:
+  guess-mysql:
+    build: docs/mysql
+    image: guess/mysql
+    command: --default-authentication-plugin=mysql_native_password
+    environment:
+      MYSQL_ROOT_PASSWORD: root
+    ports:
+      - "3316:3306"
+    volumes:
+      - data-mysql:/var/lib/mysql
+
+  guess-service:
+    build: service/guess
+    image: guess/service
+    depends_on:
+      guess-mysql:
+        condition: service_started
+    environment:
+      JAVA_OPTS: >
+        -Xss512k
+        -XX:MaxRAM=260m
+        -Dspring.profiles.active=local
+        -Dspring.datasource.password=root
+        -Dcore.url.db-mysql=jdbc:mysql://guess-mysql/guess?allowPublicKeyRetrieval=true&useSSL=false
+    ports:
+      - "8080:8080"
+    volumes:
+      - data-app:/app/guess
+
+volumes:
+  data-app:
+  data-mysql:
diff --git a/docs/devtools.setting.en.png b/docs/devtools.setting.en.png
diff --git a/docs/mysql/Dockerfile b/docs/mysql/Dockerfile
@@ -0,0 +1,4 @@
+FROM mysql:8.2.0
+
+COPY mysql.cnf /etc/mysql/mysql.conf.d/mysql.cnf
+COPY init.sql /docker-entrypoint-initdb.d/init.sql
diff --git a/docs/mysql/init.sql b/docs/mysql/init.sql
@@ -0,0 +1 @@
+CREATE DATABASE IF NOT EXISTS `guess` COLLATE utf8mb4_unicode_ci;
diff --git a/docs/mysql/mysql.cnf b/docs/mysql/mysql.cnf
@@ -0,0 +1,17 @@
+[mysqld]
+pid-file	= /var/run/mysqld/mysqld.pid
+socket		= /var/run/mysqld/mysqld.sock
+datadir		= /var/lib/mysql
+#log-error	= /var/log/mysql/error.log
+# By default we only accept connections from localhost
+#bind-address	= 127.0.0.1
+# Disabling symbolic-links is recommended to prevent assorted security risks
+symbolic-links=0
+
+#### These optimize the memory use of MySQL
+#### http://www.tocker.ca/2014/03/10/configuring-mysql-to-use-minimal-memory.html
+innodb_buffer_pool_size=32M
+innodb_log_buffer_size=512K
+
+#### from https://mariadb.com/de/node/579
+performance_schema = off
diff --git a/frontend/weapp/webpack/env/prod.env.ts b/frontend/weapp/webpack/env/prod.env.ts
@@ -2,5 +2,5 @@ import { Environment } from "./env";
 
 export const environment: Environment = {
   env: "prod",
-  host: "http://192.168.3.46:8080",
+  host: "http://localhost:8080",
 };
diff --git a/service/guess/Dockerfile b/service/guess/Dockerfile
@@ -0,0 +1,10 @@
+FROM openjdk:21-jdk
+
+RUN rm -f /etc/localtime && \
+  ln -sv /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && \
+  echo "Asia/Shanghai" > /etc/timezone
+
+ADD ./build/libs/guess-service.jar /opt/app/
+CMD java $JAVA_OPTS -jar /opt/app/guess-service.jar
+
+EXPOSE 8080
diff --git a/service/guess/src/main/resources/application-local.yml b/service/guess/src/main/resources/application-local.yml
@@ -1,8 +1,11 @@
 core:
-  jwt-secret: test-jwt-secret
   url:
     db-mysql: jdbc:mysql://127.0.0.1:3306/guess
+  weapp:
+    app-id: fake-app-id
+    app-secret: fake-app-secret
 
 spring:
   datasource:
+    username: root
     password: root
diff --git a/service/guess/src/main/resources/application.yml b/service/guess/src/main/resources/application.yml
@@ -2,11 +2,12 @@ core:
   config:
     puzzle-daily-limit: 30
     puzzle-limit-increase: 20
-    static-url: http://127.0.0.1:8080/static/
+  jwt-secret: test-jwt-secret
   url:
     db-mysql: jdbc:mysql://127.0.0.1:3306/guess
   weapp:
     app-id: fake-app-id
+    app-secret: fake-app-secret
 
 server:
   port: 8080
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		CREATE DATABASE IF NOT EXISTS `guess` COLLATE utf8mb4_unicode_ci;