#140 : 인증된 사용자 테스트

.github/workflows/deployment.dev.yml

@@ -36,5 +36,5 @@ jobs:
           yarn install
           yarn start:prod
           cd ../server
-          echo ${{ secrets.PASSWORD }}  | sudo -S sh run_docker.sh local
+          echo ${{ secrets.PASSWORD }}  | sudo -S sh run_docker.sh prod
 

README.md

@@ -1,8 +1,47 @@
 # Dicom Service Management Project
+![example workflow](https://github.com/BEOKS/DicomProject/actions/workflows/deployment.dev.yml/badge.svg)
 ## :dart: Objective
 Dicom 의료 영상 데이터를 저장, 관리하며 시각화 기능과 머신러닝 개발을 지원하는 SW개발
 ## :bar_chart: Success metrics
 의료데이터 관리 및 시각화 지원 기능을 구현하여 v1.0 배포를 목표로 한다.(option 제외)
+## Usage
+### Prerequirement
+1. 최신 버전의 도커를 설치해주세요. (docker-compose는 v2 버전으로 설치되어야 합니다, 리눅스의 경우 간혹 v1으로 설치되므로 업데이트가 필요합니다.)
+2. java SDK (version. 17.0.1)을 설치합니다. (설치하지 않을 경우 spring 프로젝트 파일이 정상적으로 실행되지 않습니다.)
+3. Node.js 가 설치되어 있지 않다면 v16.6.1버전으로 설치해야 합니다.
+4. 최신 버전의 [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable)을 설치해주세요.
+
+### Install Project
+설치의 경우 프로젝트를 다운로드 한 후, 한번만 실행하면 됩니다. 프로젝트 코드가 갱신될 경우, 코드를 반영하기 위해서 다시 실행해야 합니다.
+#### Common
+1. 코드 다운로드
+```sh 
+#clone all project with submodules
+git clone --recurse-submodules https://github.com/BEOKS/DicomProject.git
+cd DicomProject
+```
+2. 현재 프로젝트는 구글 로그인을 사용하고 있으므로 구글 API clientId와 secrect id가 필요합니다. 이를 발급받아 [application-oauth.yml.example](https://github.com/BEOKS/DicomProject/blob/main/server/DSMP/src/main/resources/application-oauth.yml.example)과 같은 형식을 작성하여 같은 파일 위치에 application-oauth.yml 파일을 생성해야 합니다.
+#### Window
+```sh
+.\install_project.sh
+```
+#### Mac, Linux
+```sh
+sudo sh install_project.sh
+```
+### Run Project
+#### Window
+```sh
+run_project.sh local # run project for development
+#localhost:3000에서 서비스 이용가능
+run_project.sh prod # run project for deploy
+```
+#### Mac, Linux
+```sh
+sudo sh run_project.sh local # run project for development
+#localhost:3000에서 서비스 이용가능
+sudo sh run_project.sh prod # run project for deploy
+```
 ## 📓 Requirements
 ### 1. 의료 데이터 관리
 Requirement | User Story | Notes | Priority

client/README.md

@@ -1,6 +1,6 @@
 # Usage
 > 이 클라이언트는 Viewer 클라이언트를 참조하기 때문에 우선 Viewer클라이언트를 실행해야한다.
-0. Node.js 가 설치되어 있지 않다면 [최신버전](https://nodejs.org/ko/download/)으로 설치해야 합니다.
+0. Node.js 가 설치되어 있지 않다면 v16.6.1버전으로 ode.js를 설치해야 합니다.
 1. 클라이언트 시작 전 [server/README.md](../server/README.md)를 참조하여 서버를 실행합니다.
 2. Viewer 서브 모듈을 업데이트 합니다.
 ```