Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
xjasonlyu committed Dec 5, 2023
1 parent 906e74b commit 97b5006
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@
- API Gateway ([Caddy](https://caddyserver.com/))
- Health Check ([Docker](https://www.docker.com/))
- Session Cache ([Redis](https://redis.io/))
- Message Queue ([RabbitMQ](https://www.rabbitmq.com/))
- Service Discovery ([Nacos](https://nacos.io/en-us/))
- Build Test CI/CD ([Actions](https://github.com/features/actions))
- Service Discovery ([Nacos](https://nacos.io/en-us/))
- Message Queue ([RabbitMQ](https://www.rabbitmq.com/))

## How to Build

Expand Down Expand Up @@ -87,12 +87,24 @@ python3 ./simulator.py 127.0.0.1:8080
## How to Test

### Player Service
### Auto Test

We automate the testing of our services using GitHub Action (CI/CD). You can view the test results at <https://github.com/CAS735-F23/macrun-archless-team/actions/workflows/test.yml>.

### Game Service
### Manual Test

### Challenge Service
If you want to run all the tests manually, go to the service folder and run test commands.

### GEO Service
- Java services, e.g. player-service:

### HRM Service
```shell
cd ./player-service
mvn test
```

- Golang services, e.g. game-service:

```shell
cd ./player-service
go test ./...
```

0 comments on commit 97b5006

Please sign in to comment.