diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..accc4afd --- /dev/null +++ b/README.md @@ -0,0 +1,62 @@ +# SHI eVCP + +## 실행 + +1. 종속성 설치 `npm i` +2. pdfTron 라이브러리 복사 + `@/public/pdftronWeb` 경로에 `core`, `ui` 폴더를 복사 +3. 실행 `npm run dev` + +## 로컬 실행을 위한 DB 준비 + +1. postgres 17 버전을 준비 (환경변수에 따라 계정 및 데이터베이스 생성) +2. drizzle-kit 으로 ORM to Database 처리 +3. 환경변수 선택을 위한 dotenv-cli 설치 `npm i -g dotenv-cli` + +development: + +```bash +npx dotenv -e .env.production -- npx drizzle-kit push +``` + +production: + +```bash +npx dotenv -e .env.development -- npx drizzle-kit push +``` + +3. 필요시 seeding 진행 (`@/db/` 경로 참조, drizzle 문서 확인) + +## 주의사항 + +- 개발한 부분과 관련없는 부분에 대해 포매팅 변경사항을 만들지 마세요. +- 자동 포맷 기능을 종료해두세요 (vscode, prettier, biome 등) + - formatOnSave 옵션을 비활성화하는 설정이 `.vscode/settings.json` 설정에 작성되어 있습니다. + +## 협업전략 + +- main, dev 브랜치에 다이렉트 푸시 X (PR 사용) +- features 브랜치에서 새로운 브랜치 생성하기 + +### github 사용하기 + +1. 조직 내 팀에 개발 인원 추가 +2. 개발 인원은 깃허브 로그인 후 클론 & 작업 내역 PR + +인증 절차는 HTTPS, SSH 등 특정 방식으로 제한하고 있지는 않으며, 적절한 방법으로 진행하시면 됩니다. + +예시 상황: AWS EC2 - CentOS 에서 크레덴셜 셋업하기 + +> ```bash +> # GH 설치하기 +> # 저장소 파일 다운로드 +> sudo curl -L https://cli.github.com/packages/rpm/gh-cli.repo -o /etc/yum.repos.d/gh-cli.repo +> +> # 저장소 활성화 및 설치 +> sudo yum install -y gh +> +> # 인증 처리하기 +> gh auth login # 이후 CLI를 통해 인증처리 진행 +> ``` + +[gh cli에 대해 알아보기](https://github.com/cli/cli) |