Skip to content

Commit 62a4013

Browse files
liweiguangclaude
andcommitted
Improve open-source project quality
- Remove 398 .idea/ IDE files from git tracking - Fix all URLs to lowercase repo name (rydr) - Add docker-compose.yml for one-click local infrastructure - Add GitHub Actions CI workflow (compile + test) - Add Issue templates (bug report, feature request) - Add Pull Request template - Add .editorconfig for consistent code style - Add POM metadata (url, scm, developers, issueManagement) - Add Spring Cloud version EOL note in README - Update Getting Started with Docker workflow Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent ca2b490 commit 62a4013

File tree

407 files changed

+190
-5717
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

407 files changed

+190
-5717
lines changed

.editorconfig

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
insert_final_newline = true
7+
trim_trailing_whitespace = true
8+
indent_style = space
9+
indent_size = 4
10+
11+
[*.{xml,yml,yaml,json}]
12+
indent_size = 2
13+
14+
[*.md]
15+
trim_trailing_whitespace = false
16+
17+
[Makefile]
18+
indent_style = tab
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug to help us improve
4+
labels: bug
5+
---
6+
7+
## Description
8+
9+
A clear description of the bug.
10+
11+
## Steps to Reproduce
12+
13+
1. Start service '...'
14+
2. Send request to '...'
15+
3. See error
16+
17+
## Expected Behavior
18+
19+
What you expected to happen.
20+
21+
## Actual Behavior
22+
23+
What actually happened. Include error logs if available.
24+
25+
## Environment
26+
27+
- Java version:
28+
- OS:
29+
- Branch/commit:
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or improvement
4+
labels: enhancement
5+
---
6+
7+
## Problem
8+
9+
What problem does this feature solve?
10+
11+
## Proposed Solution
12+
13+
Describe your proposed approach.
14+
15+
## Alternatives Considered
16+
17+
Any alternative solutions you've thought about.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Summary
2+
3+
Brief description of the changes.
4+
5+
## Changes
6+
7+
-
8+
9+
## Checklist
10+
11+
- [ ] Code compiles without errors (`mvn compile`)
12+
- [ ] No hardcoded credentials or sensitive data
13+
- [ ] Comments and docs are in English

.github/workflows/ci.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [master]
6+
pull_request:
7+
branches: [master]
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v4
15+
16+
- name: Set up JDK 8
17+
uses: actions/setup-java@v4
18+
with:
19+
java-version: "8"
20+
distribution: "temurin"
21+
cache: maven
22+
23+
- name: Compile
24+
run: mvn compile -T 4 -B -q
25+
working-directory: rydr
26+
27+
- name: Run tests
28+
run: mvn test -T 4 -B -q -Dspring.profiles.active=test
29+
working-directory: rydr
30+
continue-on-error: true # Some tests need infrastructure

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Thank you for your interest in contributing to Rydr! This document provides guid
66

77
### Reporting Issues
88

9-
- Use the [GitHub Issues](https://github.com/OiPunk/Rydr/issues) page
9+
- Use the [GitHub Issues](https://github.com/OiPunk/rydr/issues) page
1010
- Include a clear title and description
1111
- Provide steps to reproduce the issue
1212
- Include relevant logs and screenshots

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,8 @@ The system follows a **three-layer microservices architecture**:
133133
| **Real-time** | WebSocket |
134134
| **Build Tool** | Maven 3.x |
135135

136+
> **Note:** This project uses Spring Boot 2.1.x and Spring Cloud Greenwich, which have reached end-of-life. It remains a solid learning reference for microservices patterns, but production use should consider upgrading to a supported release train.
137+
136138
## Prerequisites
137139

138140
- **Java** 8+
@@ -147,8 +149,8 @@ The system follows a **three-layer microservices architecture**:
147149
### 1. Clone the Repository
148150

149151
```bash
150-
git clone https://github.com/OiPunk/Rydr.git
151-
cd Rydr
152+
git clone https://github.com/OiPunk/rydr.git
153+
cd rydr
152154
```
153155

154156
### 2. Configure Environment Variables
@@ -173,13 +175,15 @@ Key variables:
173175

174176
> See [`.env.example`](.env.example) for the full list of configurable variables.
175177
176-
### 3. Initialize the Database
178+
### 3. Start Infrastructure (Docker)
177179

178180
```bash
179-
mysql -u root -p < rydr-sql.sql
181+
docker compose up -d
180182
```
181183

182-
The SQL file creates **108 tables** covering orders, passengers, drivers, payments, configuration, and more.
184+
This starts MySQL (with schema auto-imported), Redis, ActiveMQ, and RabbitMQ. See [`docker-compose.yml`](docker-compose.yml).
185+
186+
> **Without Docker:** install each service manually and run `mysql -u root -p < rydr-sql.sql` to import the schema (108 tables).
183187
184188
### 4. Start Services (in order)
185189

@@ -229,7 +233,7 @@ cd rydr/rydr-zuul && mvn spring-boot:run
229233
## Project Structure
230234

231235
```
232-
Rydr/
236+
rydr/ # Repository root
233237
├── rydr/ # Maven parent project
234238
│ ├── api-driver/ # Driver API
235239
│ ├── api-listen-order/ # Order listener API

docker-compose.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
version: "3.8"
2+
3+
# Infrastructure services for local development.
4+
# Usage:
5+
# docker compose up -d # start all
6+
# docker compose down -v # stop and remove volumes
7+
8+
services:
9+
10+
mysql:
11+
image: mysql:5.7
12+
ports:
13+
- "${DB_PORT:-3306}:3306"
14+
environment:
15+
MYSQL_ROOT_PASSWORD: ${DB_PASSWORD:-changeme}
16+
MYSQL_DATABASE: ${DB_NAME:-rydr}
17+
volumes:
18+
- mysql-data:/var/lib/mysql
19+
- ./rydr-sql.sql:/docker-entrypoint-initdb.d/init.sql:ro
20+
command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
21+
22+
redis:
23+
image: redis:6-alpine
24+
ports:
25+
- "${REDIS_PORT:-6379}:6379"
26+
volumes:
27+
- redis-data:/data
28+
29+
activemq:
30+
image: rmohr/activemq:5.15.9-alpine
31+
ports:
32+
- "${ACTIVEMQ_PORT:-61616}:61616" # JMS
33+
- "8161:8161" # Web console
34+
environment:
35+
ACTIVEMQ_ADMIN_LOGIN: ${ACTIVEMQ_USER:-admin}
36+
ACTIVEMQ_ADMIN_PASSWORD: ${ACTIVEMQ_PASSWORD:-changeme}
37+
38+
rabbitmq:
39+
image: rabbitmq:3-management-alpine
40+
ports:
41+
- "${RABBITMQ_PORT:-5672}:5672" # AMQP
42+
- "15672:15672" # Management UI
43+
environment:
44+
RABBITMQ_DEFAULT_USER: ${RABBITMQ_USER:-guest}
45+
RABBITMQ_DEFAULT_PASS: ${RABBITMQ_PASSWORD:-guest}
46+
volumes:
47+
- rabbitmq-data:/var/lib/rabbitmq
48+
49+
volumes:
50+
mysql-data:
51+
redis-data:
52+
rabbitmq-data:

rydr/.idea/compiler.xml

Lines changed: 0 additions & 84 deletions
This file was deleted.

rydr/.idea/encodings.xml

Lines changed: 0 additions & 48 deletions
This file was deleted.

0 commit comments

Comments
 (0)