commit e47d40ebfe29c81255caa5ca2d8626d239ff4e95 parent 1fdbe2f88da0b9a8305773285bcf024508f0c62b Author: Yongbin Kim <iam@yongbin.kim> Date: Mon, 30 Jan 2023 16:10:56 +0900 README.md 작성 Signed-off-by: Yongbin Kim <iam@yongbin.kim> Diffstat:
| M | README.md | | | 81 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++---------------------- |
1 file changed, 59 insertions(+), 22 deletions(-)
diff --git a/README.md b/README.md @@ -1,38 +1,75 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +본 소프트웨어는 nextjs 프레임워크와 typescript로 작성되었습니다. -## Getting Started -First, run the development server: +## Getting started + +다음 소프트웨어가 필요합니다. + +- Node.js + - Yarn +- MySQL 8 +- Redis + +다음 내용을 참고해서 `.env.local` 파일을 작성해주세요. -```bash -npm run dev -# or -yarn dev -# or -pnpm dev ``` +WIKI_SITE_URL=https://dhdemo.yongbin.kim -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +WIKI_DB_HOST=127.0.0.1 +WIKI_DB_NAME=dreamhanks_demo +WIKI_DB_USER=dreamhanks_demo +WIKI_DB_PASS=dreamhanks_demo -You can start editing the page by modifying `pages/login.tsx`. The page auto-updates as you edit the file. +WIKI_PAGE_CACHE_TTL=3600 -[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`. +WIKI_JWT_SECRET=1q2w3e4r +WIKI_JWT_COOKIE_PREFIX=wiki_jwt_ -The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. +WIKI_SMTP_HOST=smtp.domain.tld +WIKI_SMPT_PORT=465 +WIKI_SMTP_USER=dhdemo +WIKI_SMTP_PASS=supersecurepassword! +WIKI_SMTP_FORCE_TLS=true +WIKI_SMTP_FROM=dhdemo@yongbin.kim -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. +WIKI_HOME_WIKI=main +WIKI_PAGE_ENTRY=Home -## Learn More +WIKI_SOCKET_URL=ws://localhost:3001/ws +``` -To learn more about Next.js, take a look at the following resources: +다음 명령어로 실행할 수 있습니다. -- [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. +``` +# 이벤트 큐 서버 +yarn node bin/event-queue.mjs +``` + +``` +# 앱 서버 +yarn +yarn build +yarn start +``` -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! -## Deploy on Vercel +## 소스코드 개요 -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. +다음은 소스코드의 간략한 레이아웃 개요입니다. -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +- `/` + - `bin/`: 실행 가능한 파일들. 현재는 이벤트 큐 서버 스크립트 하나뿐입니다. + - `components/`: 컴포넌트 폴더 + - `docs/`: 개발 관련 문서들 + - `lib/`: 기타 소스코드들 + - `email/`: 이메일 전송과 관련된 코드들이 들어 있습니다. + - `hooks/`: 커스텀 훅들이 들어 있습니다. + - `markup/`: 마크업 언어 파서와 렌더러 구현이 들어 있습니다. + - `models/`: 데이터베이스 모델들이 들어 있습니다. + - `security/`: 보안 관련 소스코드들이 들어 있습니다. + - `utils/`: 유틸리티 함수들이 들어 있습니다. + - 기타 분류하기 힘든 소스코드들 + - `pages/`: 페이지 폴더 + - `public/`: 정적 파일들이 들어 있습니다. + - `sql/`: 데이터베이스 스키마와 관련된 SQL 파일들 들어 있습니다. + - `styles/`: 스타일 파일들이 들어 있습니다.