Skip to content

Commit

Permalink
docs: zh doc as default (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
jinganix authored Jan 28, 2024
1 parent 88cfc55 commit 8056f93
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 77 deletions.
56 changes: 56 additions & 0 deletions README.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
[![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)

# Guess

The source code of the 'Guess Who I Am' Wechat miniprogram

## Run

### Backend

#### Linux or MacOS

```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=?'
```

#### Windows

Replace `./gradlew` with `./gradlew.bat`

#### Description

- 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

### Frontend

#### Execute commands

```shell
git@github.com:jinganix/guess.git
cd guess/frontend/weapp
npm install
npm start
```

#### Wechat devtools

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">

## Scan to experience

<img src="docs/qrcode.jpg" alt="Image" width="300" height="300">

## Contributing

If you are interested in reporting/fixing issues and contributing directly to the code base, please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information on what we're looking for and how to get started.
42 changes: 21 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
[![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)

[中文文档](README.zh.md)
[English Doc](README.en.md)

# Guess
# 猜我是谁

The source code of the 'Guess Who I Am' Wechat miniprogram
`猜我是谁`微信小程序源码

## Run
## 运行项目

### Backend
### 后端

#### Linux or MacOS
#### Linux和MacOS

```shell
git clone git@github.com:jinganix/guess.git
Expand All @@ -21,19 +21,19 @@ cd guess/service/guess

#### Windows

Replace `./gradlew` with `./gradlew.bat`
使用`./gradlew.bat`代替`./gradlew`

#### Description
#### 参数说明

- 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: 微信小程序的`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: 数据库密码

### Frontend
### 前端

#### Execute commands
#### 运行命令

```shell
git@github.com:jinganix/guess.git
Expand All @@ -42,17 +42,17 @@ npm install
npm start
```

#### Wechat devtools
#### 开发者工具设置

1. Import`guess/frontend/weapp/dist` into Wechat devtools
2. Disable domain verification
1. 开发者工具导入项目的dist目录:`guess/frontend/weapp/dist`
2. 关闭域名校验

<img src="docs/devtools.setting.png" alt="Image" width="381" height="576">

## Scan to experience
## 扫码体验

<img src="docs/qrcode.jpg" alt="Image" width="300" height="300">

## Contributing
## 贡献

If you are interested in reporting/fixing issues and contributing directly to the code base, please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information on what we're looking for and how to get started.
如果您有兴趣报告/修复问题并直接为代码库做出贡献,请查看 [CONTRIBUTING.md](CONTRIBUTING.md) 获取更多信息,了解我们期望的贡献内容以及如何开始。
56 changes: 0 additions & 56 deletions README.zh.md

This file was deleted.

0 comments on commit 8056f93

Please sign in to comment.