From 4980e4fdc76272e4e1c2d97bb58af78b23da1c08 Mon Sep 17 00:00:00 2001 From: 6mn12j Date: Thu, 10 Nov 2022 22:40:24 +0900 Subject: [PATCH 1/2] =?UTF-8?q?Docs:=20=EC=82=AC=EC=9A=A9=ED=95=98?= =?UTF-8?q?=EC=A7=80=20=EC=95=8A=EB=8A=94=20=ED=99=98=EA=B2=BD=EB=B3=80?= =?UTF-8?q?=EC=88=98=20=EC=A0=9C=EA=B1=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .env.sample | 3 ++- .github/workflows/s3_deploy_dev.yml | 1 - .github/workflows/s3_deploy_master.yml | 1 - 3 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.env.sample b/.env.sample index 234b252..990782a 100644 --- a/.env.sample +++ b/.env.sample @@ -1,3 +1,4 @@ +// *: 필수값 REACT_APP_ENV = *환경 (ex:development,local,production) REACT_APP_API_URL= *server api (ex: http://localhost:3000) -REACT_APP_SENTRY_DSN = *Sentry DSN key (ex: Sentry credential 파일 확인) \ No newline at end of file +REACT_APP_SENTRY_DSN = Sentry DSN key (ex: Sentry credential 파일 확인) \ No newline at end of file diff --git a/.github/workflows/s3_deploy_dev.yml b/.github/workflows/s3_deploy_dev.yml index 7f13db4..4671624 100644 --- a/.github/workflows/s3_deploy_dev.yml +++ b/.github/workflows/s3_deploy_dev.yml @@ -10,7 +10,6 @@ jobs: AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} REACT_APP_API_URL: ${{secrets.REACT_APP_API_URL_DEV}} - REACT_APP_COOKIE_DOMAIN: ${{secrets.REACT_APP_COOKIE_DOMAIN}} REACT_APP_ENV: ${{secrets.REACT_APP_ENV_DEV}} REACT_APP_SENTRY_DSN: ${{secrets.REACT_APP_SENTRY_DSN}} diff --git a/.github/workflows/s3_deploy_master.yml b/.github/workflows/s3_deploy_master.yml index 195059d..a295f82 100644 --- a/.github/workflows/s3_deploy_master.yml +++ b/.github/workflows/s3_deploy_master.yml @@ -10,7 +10,6 @@ jobs: AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} REACT_APP_API_URL: ${{secrets.REACT_APP_API_URL}} - REACT_APP_COOKIE_DOMAIN: ${{secrets.REACT_APP_COOKIE_DOMAIN}} REACT_APP_ENV: ${{secrets.REACT_APP_ENV}} REACT_APP_SENTRY_DSN: ${{secrets.REACT_APP_SENTRY_DSN}} From 19ec968b6885099ff9384b8778822e2797a472ca Mon Sep 17 00:00:00 2001 From: 6mn12j Date: Thu, 10 Nov 2022 22:40:54 +0900 Subject: [PATCH 2/2] =?UTF-8?q?Docs:=20README=20=EC=8B=A4=ED=96=89?= =?UTF-8?q?=EB=B0=A9=EB=B2=95,=20=EB=B0=B0=ED=8F=AC=EB=B0=A9=EB=B2=95=20?= =?UTF-8?q?=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 90 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 66 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index e95f1ae..60fe313 100644 --- a/README.md +++ b/README.md @@ -1,62 +1,104 @@ # 24HANE (42Checkin_v3-frontend) -# INTRO -**24 HANE(24 hours are not enough)** +# 프로젝트 실행 방법 + +해당 앱은 벡엔드 서버와, env 설정이 필요합니다. +벡엔드 설정을 아래의 링크를 따라가서 설정해 주시고 env설정은 `env.sample` 을 참고하여 작성 하여 주시기 바랍니다. + +### 앱 실행 + +- 해당 레포를 clone 받습니다. +- [벡엔드 레포](https://github.com/innovationacademy-kr/42checkin_v3-backend) 를 클론 받습니다. + +``` +//의존성 패키지 설정 +npm install + +//코드를 실행 합니다 +npm run start +``` + +# 프로젝트 배포 방법 + +### GithubActions 설정 + +배포자동화를 통해서 아래 와 같이 연동 되어 있습니다. + +- main 브랜치는 상용 서버와 연동 +- develop 브랜치는 개발 서버와 연동 + +배포 자동화에 대한 yml 파일은 [링크](https://github.com/innovationacademy-kr/42checkin_v3-frontend/tree/master/.github/workflows)에서 확인 가능 합니다. 해당 파일의 env 값들은 `Actions secrets` 을 이용하여 변경 가능 합니다. + +``` +AWS_ACCESS_KEY_ID //AWS CLI 사용하기 위한 access key +AWS_SECRET_ACCESS_KEY //AWS CLI 사용하기 위한 secret access key +DEFAULT_BUCKET_REGION //S3 버킷 위치 아시아 태평양 (서울) "ap-northeast-2" +CLOUDFRONT_DISTRIBUTION_ID //CloudFront ID 상용 +CLOUDFRONT_DISTRIBUTION_ID_DEV //CloudFront ID 개발용 +S3_BUCKET //S3 Bucket 이름 상용 +S3_BUCKET_DEV //S3 Bucket 이름 개발용 + +REACT_APP_ENV //개발 환경 (ex: development,local,production) +REACT_APP_API_URL_DEV //server url (ex. https://localhost:3000) +REACT_APP_SENTRY_DSN = Sentry DSN key (ex: Sentry credential 파일 확인) +``` +# 프로젝트 소개 +**24 HANE(24 hours are not enough)** ``` 카뎃 여러분이 직접 클러스터 출입 누적 시간을 확인할 수 있는 24 HANE 서비스를 소개합니다. - 클러스터 출입태깅이 잘 됐는지 궁금한가요? - 클러스터 출입 누적 시간이 궁금한가요? - + 24HANE 서비스를 이용해서 확인 할 수 있습니다. - 클러스터 출입 누적 시간을 오늘/이번 달 기준으로 한 눈에 볼 수 있습니다. - 상세한 클러스터 출입 기록을 확인할 수 있습니다. - - 자정 전후로 별도 태깅 없이 학습에만 몰입 할 수 있습니다. - ``` - + - 자정 전후로 별도 태깅 없이 학습에만 몰입 할 수 있습니다. +``` +
스크린샷 2022-10-02 오후 5 04 40
위의 로고를 클릭하여, 24HANE 으로 접속하세요! [사이트 링크](https://24hoursarenotenough.42seoul.kr/) +
# 기술 스택 +

- +

- # 기능 소개 + - **로그인** - - Intra 로그인을 통해 서비스 로그인이 가능합니다. - + - Intra 로그인을 통해 서비스 로그인이 가능합니다. - **MainPage** - - 로그인 후 바로 보이는 페이지로 본인의 정보와 출입 누적 시간(오늘, 이번 달) 현황을 한 눈에 볼 수 있습니다. - - **`개인 정보`** 본인의 인트라 사진과 아이디를 통해 본인의 정보를 확인합니다. - - **`입출입 여부`** 인트라 사진의 우측 상단에 있는 작은 원으로 입 출입 여부가 표시됩니다. - - **(초록색🟢)** 정상적으로 입실(check-in) 되었음을 의미합니다. - - **(회색⚪)** 정상적으로 퇴실(check-out) 되었음을 의미합니다. - - **`오늘 누적시간`** 오늘의 클러스터 누적 시간을 표시합니다. - - 단, 개인별 사진 출입 카드의 ‘입실’ 과 ‘퇴실’ 태깅 짝이 일치하는 경우에만 ‘오늘 누적 시간’이 기록됩니다. - - 따라서, 입실(check-in) 중일 경우 오늘 누적 시간은 기록되지 않으며 퇴실(check-out) 태깅이 확인 된 후 누적 시간이 기록됩니다. - - **`이번 달 누적시간`** 이번 달 클러스터 누적 시간을 표시합니다. - - 우측 상단에 있는 버튼을 클릭🖱️하면 SUB PAGE로 이동합니다! 🚀🪂🌌 -

메인페이지 스크린샷

+ - 로그인 후 바로 보이는 페이지로 본인의 정보와 출입 누적 시간(오늘, 이번 달) 현황을 한 눈에 볼 수 있습니다. + - **`개인 정보`** 본인의 인트라 사진과 아이디를 통해 본인의 정보를 확인합니다. + - **`입출입 여부`** 인트라 사진의 우측 상단에 있는 작은 원으로 입 출입 여부가 표시됩니다. + - **(초록색🟢)** 정상적으로 입실(check-in) 되었음을 의미합니다. + - **(회색⚪)** 정상적으로 퇴실(check-out) 되었음을 의미합니다. + - **`오늘 누적시간`** 오늘의 클러스터 누적 시간을 표시합니다. + - 단, 개인별 사진 출입 카드의 ‘입실’ 과 ‘퇴실’ 태깅 짝이 일치하는 경우에만 ‘오늘 누적 시간’이 기록됩니다. + - 따라서, 입실(check-in) 중일 경우 오늘 누적 시간은 기록되지 않으며 퇴실(check-out) 태깅이 확인 된 후 누적 시간이 기록됩니다. + - **`이번 달 누적시간`** 이번 달 클러스터 누적 시간을 표시합니다. + - 우측 상단에 있는 버튼을 클릭🖱️하면 SUB PAGE로 이동합니다! 🚀🪂🌌 +

메인페이지 스크린샷

- **SubPage** - - 이번 달 총 입, 퇴실 기록을 확인할 수 있는 페이지 입니다. - - **`입-퇴실 상세 내역`** 입-퇴실 별 상세 기록과 입-퇴실에 따른 체류 시간을 확인할 수 있습니다. 데이터가 많을 경우 스크롤을 내려 정보를 확인하시면 됩니다. + - 이번 달 총 입, 퇴실 기록을 확인할 수 있는 페이지 입니다. + - **`입-퇴실 상세 내역`** 입-퇴실 별 상세 기록과 입-퇴실에 따른 체류 시간을 확인할 수 있습니다. 데이터가 많을 경우 스크롤을 내려 정보를 확인하시면 됩니다. - **`문의하기`** 입-퇴실 내역에 궁금한 점이 있거나, 기타 서비스 관련 문의 사항이 있을 경우 문의하기 버튼을 눌러 설문을 작성해주세요. - SUB PAGE 우측 상단에 있는 버튼을 클릭🖱️하면 다시 MAIN PAGE로 이동합니다! 🚀🪂🌌

서브페이지 스크린샷

-