From b9482eb3873a62e8df185122df580368f9842f5e Mon Sep 17 00:00:00 2001
From: nate2402 <nate2402@ajou.ac.kr>
Date: Tue, 8 Apr 2025 02:47:20 +0900
Subject: [PATCH] docs: add readme

---
 README.md | 81 ++++++++++++++++++++++++++++++++++++++++---------------
 1 file changed, 60 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index e215bc4..3b0badb 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,75 @@
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+# AJ Lib Phrase
+> 책 속 한문장 추천서비스 개발 프로젝트
 
-## Getting Started
+(Developped by waffle, 2025)
 
-First, run the development server:
+## 시작하기
 
+### A) 일반 실행 방법
+
+1. 필수 요구사항:
+   - Node.js 14.0.0 이상
+   - npm 또는 yarn
+
+2. 프로젝트 클론:
 ```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
+git clone https://github.com/nate2402/AJ_Lib_Phrase.git
+cd AJ_Lib_Phrase
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+3. 의존성 설치:
+```bash
+# npm 사용 시
+npm install
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+# yarn 사용 시
+yarn install
+```
 
-This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+4. 프로덕션 빌드:
+```bash
+# npm 사용 시
+npm run build
+npm start
 
-## Learn More
+# yarn 사용 시
+yarn build
+yarn start
+```
 
-To learn more about Next.js, take a look at the following resources:
+### B) Docker를 이용한 실행 방법
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+1. 필수 요구사항:
+   - Docker
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+2. Docker 이미지 빌드:
+```bash
+docker build -t aj-lib-phrase .
+```
 
-## Deploy on Vercel
+3. Docker 컨테이너 실행:
+```bash
+docker run -p 3000:3000 aj-lib-phrase
+```
+
+## 환경 변수 설정
+
+프로젝트 루트에 `.env` 파일을 생성하고 필요한 환경 변수를 설정하세요.
+
+```env
+# 예시
+NEXT_PUBLIC_API_URL=your_api_url
+```
+
+---
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+## 프로젝트 구조
+```
+AJ_Lib_Phrase/
+├── src/ # 소스 코드
+├── public/ # 정적 파일
+├── .next/ # Next.js 빌드 출력
+├── node_modules/ # 의존성 모듈
+└── ...
+```
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
-- 
GitLab