Skip to content

Commit 19cb839

Browse files
authored
Update README.md
1 parent bfca10a commit 19cb839

1 file changed

Lines changed: 28 additions & 24 deletions

File tree

README.md

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# BlockCloud Backend
2+
23
[![codecov](https://codecov.io/gh/BlockCloud-dev/blockcloud-backend/branch/main/graph/badge.svg)](https://codecov.io/gh/BlockCloud-dev/blockcloud-backend)
34

45
BlockCloud is a Spring Boot-based backend service designed to support the core functionalities of the BlockCloud application.
@@ -7,16 +8,16 @@ BlockCloud is a Spring Boot-based backend service designed to support the core f
78

89
## 📚 Documentation
910

10-
- [Installation Guide](./docs/installation.md)
11-
- [Usage Guide](./docs/usage.md)
12-
- [Configuration Guide](./docs/configuration.md)
13-
- [Development Guide](./docs/development.md)
11+
* [Installation Guide](./docs/installation.md)
12+
* [Usage Guide](./docs/usage.md)
13+
* [Configuration Guide](./docs/configuration.md)
14+
* [Development Guide](./docs/development.md)
1415

1516
---
1617

1718
## 🏁 Quick Start
1819

19-
### 로컬 개발 환경
20+
### Local Development
2021

2122
```bash
2223
git clone https://github.com/your-username/blockcloud-backend.git
@@ -26,54 +27,55 @@ cd blockcloud-backend
2627

2728
Visit: [http://localhost:8080](http://localhost:8080)
2829

29-
### Docker를 사용한 실행
30+
### Run with Docker
3031

3132
```bash
32-
# 개발 환경 실행
33+
# Run in development environment
3334
docker-compose --profile dev up -d
3435

35-
# 프로덕션 환경 실행
36+
# Run in production environment
3637
docker-compose up -d
3738
```
3839

39-
## 🚀 배포
40+
## 🚀 Deployment
41+
42+
### Automated Deployment (GitHub Actions)
4043

41-
### 자동 배포 (GitHub Actions)
44+
1. Configure GitHub Secrets:
4245

43-
1. GitHub Secrets 설정:
44-
- `HOST`: 서버 IP 주소
45-
- `USERNAME`: SSH 사용자명
46-
- `SSH_KEY`: SSH 개인키
47-
- `PORT`: SSH 포트 (기본값: 22)
46+
* `HOST`: Server IP address
47+
* `USERNAME`: SSH username
48+
* `SSH_KEY`: SSH private key
49+
* `PORT`: SSH port (default: 22)
4850

49-
2. main 브랜치에 push하면 자동으로 배포됩니다.
51+
2. Push to the **main** branch to trigger automated deployment.
5052

51-
### 수동 배포
53+
### Manual Deployment
5254

5355
```bash
54-
# 배포 스크립트 실행
56+
# Run the deployment script
5557
chmod +x scripts/deploy.sh
5658
./scripts/deploy.sh production latest
5759
```
5860

59-
## 🔧 환경 변수
61+
## 🔧 Environment Variables
6062

61-
프로젝트 루트에 `.env` 파일을 생성하고 다음 변수들을 설정하세요:
63+
Create a `.env` file at the project root and set the following variables:
6264

6365
```bash
64-
# Spring Boot 프로필
66+
# Spring Boot profile
6567
SPRING_PROFILES_ACTIVE=dev
6668

67-
# 데이터베이스 설정
69+
# Database settings
6870
SPRING_DATASOURCE_URL=jdbc:postgresql://localhost:5432/blockcloud_dev
6971
SPRING_DATASOURCE_USERNAME=blockcloud
7072
SPRING_DATASOURCE_PASSWORD=password
7173

72-
# JWT 설정
74+
# JWT settings
7375
JWT_SECRET=your-jwt-secret-key-here
7476
JWT_EXPIRATION=86400000
7577

76-
# OAuth2 설정
78+
# OAuth2 settings
7779
GOOGLE_CLIENT_ID=your-google-client-id
7880
GOOGLE_CLIENT_SECRET=your-google-client-secret
7981
```
@@ -83,3 +85,5 @@ GOOGLE_CLIENT_SECRET=your-google-client-secret
8385
## 📄 License
8486

8587
This project is licensed under the MIT License.
88+
89+
---

0 commit comments

Comments
 (0)