summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md44
1 files changed, 18 insertions, 26 deletions
diff --git a/README.md b/README.md
index e215bc4c..249b4a58 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,28 @@
-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).
+# SHI eVCP
-## Getting Started
+## 실행
-First, run the development server:
+1. 종속성 설치 `npm i`
+2. pdfTron 라이브러리 복사
+ `@/public/pdftronWeb` 경로에 `core`, `ui` 폴더를 복사
+3. 실행 `npm run dev`
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
-
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
-
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+## 로컬 실행을 위한 DB 준비
-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.
+1. postgres 17 버전을 준비 (환경변수에 따라 계정 및 데이터베이스 생성)
+2. drizzle-kit 으로 ORM to Database 처리
-## Learn More
-
-To learn more about Next.js, take a look at the following resources:
+```ts
+npx drizzle-kit push
+```
-- [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.
+3. 필요시 seeding 진행 (`@/db/` 경로 참조, drizzle 문서 확인)
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+## 주의사항
-## Deploy on Vercel
+- 가능하면 포매팅으로 인한 변경사항을 발생시키지 마세요
+- 따라서 자동 포맷 기능을 종료해두세요 (vscode, prettier, biome 등)
-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/app/building-your-application/deploying) for more details.
+- main, dev 브랜치에 다이렉트 푸시 X (PR 사용)