Skip to content

Commit b3134f3

Browse files
authored
Update readme.md
1 parent caca79c commit b3134f3

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

Diff for: readme.md

+17-7
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,36 @@
1-
# Velog Dashboard
1+
## Velog Dashboard
2+
- **📅 진행 기간** 2024. 11 ~ ONGOING
3+
- **💻 서비스 URL** https://velog-dashboard.kro.kr/ (서비스 체험 가능!)
24

3-
![](https://cdn.jsdelivr.net/gh/five-standard/images@main/Back-VD.png)
5+
## INTRO
6+
통계 기능이 부실한 블로그 서비스들을 위한 **블로그 통계 대시보드 서비스**입니다.
47

5-
## 실행
8+
현재는 Velog 게시물 통계 조회 기능을 제공하고 있으며, 추후 통계 리더보드 및 타 서비스와의 연동을 계획하고 있습니다.
9+
10+
현재 <ins>**200+**</ins>명의 유저들이 서비스를 사용하고 있으며, <ins>**20000+**</ins>개의 게시물의 통계를 관리하고 있습니다.
11+
12+
또한, 프로젝트 초기부터 배포까지의 [회고록](https://velog.io/@six-standard/series/Velog-Dashboard-%EC%B0%B8%EC%97%AC%EA%B8%B0)을 매주 작성하였습니다.
13+
14+
## SETUP DOCS
15+
### 실행
616

717
- `git clone https://github.com/Check-Data-Out/velog-dashboard-v2-fe.git`
818
- `cd velog-dashboard-v2-fe`
919
- `pnpm install`
1020
- `pnpm husky` (husky 설정)
1121
- `pnpm dev`
1222

13-
## 린팅
23+
### 린팅
1424

1525
- `pnpm lint` (lint only pages)
1626
- `pnpm lintTest` (lint only tests)
1727
- `pnpm format` (prettier)
1828

19-
## 테스팅
29+
### 테스팅
2030

2131
- `pnpm test` (test all pages & components)
2232

23-
## local 에서 docker image 생성, 태깅, 푸시, 테스팅까지
33+
### local 에서 docker image 생성, 태깅, 푸시, 테스팅까지
2434

2535
```shell
2636
# 1. 만약 코드 수정했고, 빌드를 로컬에서 했다면, 또는 Dockerfile 을 수정했다면
@@ -38,7 +48,7 @@ docker pull nuung/velog-dashboard-v2-fe:latest
3848
docker run -p 3000:3000 nuung/velog-dashboard-v2-fe:latest
3949
```
4050

41-
## docker 관련, 이미지 정리
51+
### docker 관련, 이미지 정리
4252

4353
```shell
4454
# 사용하지 않는 모든 이미지 정리

0 commit comments

Comments
 (0)