|
1 | 1 | # 맏춤법 검사기 |
2 | 2 |
|
3 | | -올바른 한국어 문장을 흔히 보이는 맞춤법/띄어쓰기 실수 형태로 바꿔 보여주는 React/Vite 앱입니다. |
| 3 | +올바른 한국어 문장을 사람들이 자주 헷갈리는 표기로 바꿔 보여주는 리버스 맞춤법 검사기입니다. |
4 | 4 |
|
5 | | -서비스: https://reverse-spell-checker.vercel.app/ |
| 5 | +- 서비스: https://reverse-spell-checker.vercel.app/ |
| 6 | +- GitHub: https://github.com/makersfarm/reverse-spell-checker |
6 | 7 |
|
7 | | -## 주요 기능 |
| 8 | +## 무엇을 하나요 |
8 | 9 |
|
9 | | -- 되/돼, 안/않, 왜/외, 며칠/몇일처럼 자주 헷갈리는 한국어 표현을 문장 안에서 표시 |
10 | | -- 맞춤법, 띄어쓰기, 표준어, 외래어 분류별 결과 제공 |
11 | | -- 결과 복사, 공유, 이미지 저장 |
| 10 | +- 되/돼, 안/않, 왜/외, 며칠/몇일처럼 자주 헷갈리는 표현을 문장 안에서 표시합니다. |
| 11 | +- 맞춤법, 띄어쓰기, 표준어, 외래어 분류별로 바뀐 표현을 보여줍니다. |
| 12 | +- 결과를 복사하거나 공유하고, 이미지로 저장할 수 있습니다. |
| 13 | +- 빠진 표현은 앱 안에서 가볍게 남길 수 있고, GA4에는 원문 대신 분류와 길이만 보냅니다. |
12 | 14 |
|
13 | | -## 구성 |
| 15 | +## 프로젝트 구조 |
14 | 16 |
|
15 | | -- `client/`: React 프론트엔드 |
16 | | -- `server/`: 프로덕션 정적 파일 서빙용 Express 서버 |
17 | | -- `shared/`: 클라이언트/서버 공유 상수 |
| 17 | +```txt |
| 18 | +client/ React + Vite 프론트엔드 |
| 19 | +server/ 프로덕션 정적 파일 서빙용 Express 서버 |
| 20 | +shared/ 클라이언트/서버 공유 코드 |
| 21 | +docs/ 맞춤법 규칙과 운영 문서 |
| 22 | +``` |
| 23 | + |
| 24 | +핵심 파일: |
| 25 | + |
| 26 | +- `client/src/pages/Home.tsx`: 메인 화면, 입력/결과/공유/표현 추가 UI |
| 27 | +- `client/src/lib/reverseSpellCheck.ts`: 리버스 맞춤법 변환 로직 |
| 28 | +- `client/src/lib/reverseSpellCheck.fixtures.ts`: 룰 테스트 fixture |
| 29 | +- `client/src/lib/analytics.ts`: GA4 이벤트 전송 |
| 30 | +- `docs/spelling-rules.md`: 현재 적용된 규칙 정리 |
| 31 | +- `RULE_UPDATE.md`: 새 맞춤법 룰을 추가할 때의 기준 |
18 | 32 |
|
19 | 33 | ## 로컬 개발 |
20 | 34 |
|
|
23 | 37 | - Node.js 20 이상 |
24 | 38 | - pnpm |
25 | 39 |
|
26 | | -의존성 설치: |
27 | | - |
28 | 40 | ```bash |
29 | 41 | pnpm install |
30 | | -``` |
31 | | - |
32 | | -개발 서버 실행: |
33 | | - |
34 | | -```bash |
35 | 42 | pnpm dev |
36 | 43 | ``` |
37 | 44 |
|
38 | | -타입 체크: |
| 45 | +검증: |
39 | 46 |
|
40 | 47 | ```bash |
41 | 48 | pnpm check |
42 | | -``` |
43 | | - |
44 | | -테스트 실행: |
45 | | - |
46 | | -```bash |
47 | 49 | pnpm test |
48 | | -``` |
49 | | - |
50 | | -프로덕션 빌드: |
51 | | - |
52 | | -```bash |
53 | 50 | pnpm build |
54 | 51 | ``` |
55 | 52 |
|
56 | | -빌드 결과 미리보기: |
| 53 | +한 번에 확인: |
57 | 54 |
|
58 | 55 | ```bash |
59 | | -pnpm preview |
| 56 | +pnpm qa |
60 | 57 | ``` |
61 | 58 |
|
62 | | -## Vercel |
| 59 | +## 배포 |
63 | 60 |
|
64 | | -이 저장소를 Vercel에 가져올 때 `reverse-spell-checker` 디렉터리를 프로젝트 루트로 지정합니다. Vercel의 Vite 프리셋 기준 설정은 다음과 같습니다. |
| 61 | +Vercel Git 연동을 사용합니다. `main` 브랜치에 push하면 Production 배포가 생성됩니다. |
65 | 62 |
|
| 63 | +Vercel 설정: |
| 64 | + |
| 65 | +- Repository: `makersfarm/reverse-spell-checker` |
| 66 | +- Framework Preset: `Vite` |
66 | 67 | - Install Command: `pnpm install --frozen-lockfile` |
67 | 68 | - Build Command: `pnpm build` |
68 | 69 | - Output Directory: `dist/public` |
| 70 | +- Production Branch: `main` |
| 71 | + |
| 72 | +자세한 내용은 [DEPLOYMENT.md](./DEPLOYMENT.md)를 봅니다. |
| 73 | + |
| 74 | +## 문서 |
| 75 | + |
| 76 | +- [맞춤법 룰 업데이트 기준](./RULE_UPDATE.md) |
| 77 | +- [현재 적용 규칙](./docs/spelling-rules.md) |
| 78 | +- [룰 후보 정리](./RULE_CANDIDATES.md) |
| 79 | +- [기능 명세](./SPEC.md) |
| 80 | +- [배포 운영](./DEPLOYMENT.md) |
| 81 | + |
| 82 | +## 운영 메모 |
69 | 83 |
|
70 | | -현재 MVP에는 런타임 환경 변수가 필요하지 않습니다. |
| 84 | +- 사이트명은 `리버스 맞춤법 검사기`, 화면 타이틀은 `맏춤법 검사기`입니다. |
| 85 | +- 커스텀 도메인은 나중에 붙입니다. 현재 대표 URL은 Vercel 기본 도메인입니다. |
| 86 | +- sitemap은 `sitemap.xml` 하나만 사용합니다. |
| 87 | +- 일반 웹페이지는 Google Indexing API 대상이 아닙니다. 검색 노출 개선은 Search Console URL 검사, sitemap 제출, 외부 링크, 정적 본문 보강으로 처리합니다. |
0 commit comments