Feature/version up

.github/pull_request_template.md

@@ -0,0 +1,8 @@
+#### Summary
+
+- PR의 내용을 요약해주세요.
+
+
+#### Description
+
+- 본문에 무엇을 변경하였는지 자세히 적어주세요.

.github/workflows/backend-cd.yml

@@ -0,0 +1,65 @@
+name: deploy to amazon ecs
+
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - "backend/**"
+
+env:
+  AWS_REGION: ap-northeast-2
+  ECR_URL: ${{ secrets.ECR_URL }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.SUBMODULE_TOKEN }}
+          submodules: true
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: 'gradle'
+
+      - name: Get git commit rev
+        id: vars
+        run: echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
+
+      - name: Grant execute permission for gradlew
+        working-directory: ./backend
+        run: chmod +x ./gradlew
+
+      - name: Build Jar
+        working-directory: ./backend
+        run: ./gradlew bootJar -Dspring.profiles.active=prod
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v2
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: ${{ secrets.AWS_REGION }}
+
+      - name: Login to Amazon ECR
+        id: login-ecr
+        uses: aws-actions/amazon-ecr-login@v2
+
+      - name: Build Docker Image & Push
+        uses: docker/build-push-action@v5
+        with:
+          context: ./backend
+          file: ./backend/Dockerfile
+          push: true
+          tags: ${{ env.ECR_URL }}:latest
+          provenance: false
+
+      - name: Deploy to Amazon ECS
+        run: |
+          aws ecs update-service --cluster ${{ secrets.CLUSTER }} --service ${{ secrets.SERVICE }} --force-new-deployment \
+          --region ${{ env.AWS_REGION }}

.github/workflows/pull-request.yml

@@ -0,0 +1,30 @@
+name : ci
+
+on:
+  pull_request:
+    paths:
+      - "backend/**"
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.SUBMODULE_TOKEN }}
+          submodules: true
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: 'gradle'
+
+      - name: Grant execute permission for gradlew
+        working-directory: ./backend
+        run: chmod +x ./gradlew
+
+      - name: Test
+        working-directory: ./backend
+        run: ./gradlew clean test

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "backend/dclass-secret"]
+	path = backend/dclass-secret
+	url = https://github.com/devbelly/dclass-secret.git

README.md

@@ -1,76 +1,140 @@
-# Welcome to GitHub
+<div align="center">
+<img src="https://github.com/kookmin-sw/capstone-2024-07/assets/67682840/a6255c3f-ff7a-43b7-8e14-7e1199be3ac0" width="250px">
+<h1>디클</h1>
 
-캡스톤 팀 생성을 축하합니다.
+|                                                     Play Store                                                     |                                                     App Store                                                     |
+| :----------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------: |
+| <img src="https://github.com/kookmin-sw/capstone-2024-07/assets/67682840/1d1f1759-112d-4aee-9e56-1ebc678ee82b" width="200px;" height="200px;"/> | <img src="https://github.com/kookmin-sw/capstone-2024-07/assets/67682840/b497c251-fa9a-4880-ba53-05d32d3a519a" width="200px;" height="200px;"/> |
 
-## 팀소개 및 페이지를 꾸며주세요.
+![image](https://github.com/kookmin-sw/capstone-2024-07/assets/67682840/07265690-0986-49e2-b73f-06e9b606811f)
 
-- 프로젝트 소개
-  - 프로젝트 설치방법 및 데모, 사용방법, 프리뷰등을 readme.md에 작성.
-  - Api나 사용방법등 내용이 많을경우 wiki에 꾸미고 링크 추가.
+</div>
 
-- 팀페이지 꾸미기
-  - 프로젝트 소개 및 팀원 소개
-  - index.md 예시보고 수정.
+### 1. 프로젝트 소개
+- 디클(Department class)은 전국의 대학생들이 학과를 중심으로 모여 소통할 수 있는 학과별 커뮤니티 서비스입니다. 모든 유저가 자신의 소속 학교나 동아리가 아닌 학과별로 자유롭게 모여 같은 학과끼리만 이해할 수 있는 깊은 고민과 전공 관련 정보를 공유할 수 있게 돕고자 합니다.
 
-- GitHub Pages 리파지토리 Settings > Options > GitHub Pages 
-  - Source를 marster branch
-  - Theme Chooser에서 태마선택
-  - 수정후 팀페이지 확인하여 점검.
+### 2. 소개 영상
+[![소개 영상](http://img.youtube.com/vi/f8lyoE0JIKA/0.jpg)](https://youtu.be/f8lyoE0JIKA?si=rLR_N2X6oFqUPunp)
 
-**팀페이지 주소** -> https://kookmin-sw.github.io/ '{{자신의 리파지토리 아이디}}'
+### 3. 팀 소개
 
-**예시)** 2023년 0조  https://kookmin-sw.github.io/capstone-2023-00/
+|                                                                         Frontend                                                                          |                                                                         Frontend                                                                          |                                                                          Backend                                                                          |                                                                          Backend                                                                          |
+| :-------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------: |
+| <img src="https://github.com/kookmin-sw/capstone-2024-07/assets/83686088/20e5982d-d7b3-4dda-8762-74059308bb9c" width="200px;" height="200px;" alt="권지아"/> | <img src="https://github.com/kookmin-sw/capstone-2024-07/assets/83686088/ac277479-2e56-481a-ae39-196fea859597" width="200px;" height="200px;" alt="윤홍현"/> | <img src="https://github.com/kookmin-sw/capstone-2024-07/assets/83686088/e1e3d13b-7835-4d93-9f9d-89656ea54a4f" width="200px;" height="200px;" alt="윤웅배"/> | <img src="https://github.com/kookmin-sw/capstone-2024-07/assets/83686088/ad14a84b-6c9e-4866-92f0-2546c6be63d5" width="200px;" height="200px;" alt="김동윤"/> |
+|                                                          [권지아(팀장)](https://github.com/jia5232/)                                                           |                                                            [윤홍현](https://github.com/hongbuly)                                                             |                                                            [윤웅배](https://github.com/devbelly)                                                             |                                                           [김동윤](https://github.com/zkxmdkdltm)                                                            |
 
+```
+✨ Name : 권지아
+👩‍🎓 Student ID : 20190155
+📌 Role: 팀장, 기획, 프론트엔드
+```
 
-## 내용에 아래와 같은 내용들을 추가하세요.
+```
+✨ Name : 윤홍현
+👩‍🎓 Student ID : 20213032
+📌 Role: UI, 프론트엔드
+```
 
-### 1. 프로잭트 소개
+```
+✨ Name : 윤웅배
+👩‍🎓 Student ID : 20171659
+📌 Role: 백엔드, 인프라
+```
 
-프로젝트
+```
+✨ Name : 김동윤
+👩‍🎓 Student ID : 20212674
+📌 Role: 백엔드, 인프라
+```
 
-### 2. 소개 영상
+### 4. 기술 스택
 
-프로젝트 소개하는 영상을 추가하세요
+![image](https://github.com/kookmin-sw/capstone-2024-07/assets/67682840/b9be449b-ddfe-44b8-99c6-93c1554ae7d3)
 
-### 3. 팀 소개
 
-팀을 소개하세요.
+### 5. 서비스 구조도
 
-팀원정보 및 담당이나 사진 및 SNS를 이용하여 소개하세요.
+![image](https://github.com/kookmin-sw/capstone-2024-07/assets/67682840/893f626b-ab39-46c2-bd12-a04ec68bbe69)
 
-### 4. 사용법
 
-소스코드제출시 설치법이나 사용법을 작성하세요.
+### 6. 사용법
 
-### 5. 기타
+#### Backend
 
-추가적인 내용은 자유롭게 작성하세요.
+- Prerequisite
+  - Java 17
+  - docker compose
 
 
-## Markdown을 사용하여 내용꾸미기
+- 로컬 MYSQL 설치하기(M1 기준)
+  - 백엔드 파일 경로로 진입
 
-Markdown은 작문을 스타일링하기위한 가볍고 사용하기 쉬운 구문입니다. 여기에는 다음을위한 규칙이 포함됩니다.
+    ```
+    cd backend
+    ```
+  - `docker-compose`를 데몬으로 실행
+    ```
+    docker-compose up -d
+    ```
+  - `backend/src/main/resources/application.yml` 포트 수정
+      ```yml
+      spring:
+        datasource:
+          url: jdbc:mysql://localhost:{HOST_PORT}/dclass?serverTimezone=UTC
+      ```
 
-```markdown
-Syntax highlighted code block
+- AWS 설정하기
+  - `backend/src/main/resources`에 `application-security.yml` 파일 생성 후 아래 내용 작성
 
-# Header 1
-## Header 2
-### Header 3
+     ```yml
+     aws:
+       access-key: <YOUR_AWS_ACCESS_KEY>
+       secret-key: <YOUR_AWS_SECRET_KEY>
+
+       s3:
+         bucket: <YOUR_BUCKET_NAME>
+         region: "ap-northeast-2"
+     ```
 
-- Bulleted
-- List
+- 로컬 실행하기
+  - `backend`에서 아래 명령어 실행
 
-1. Numbered
-2. List
+    ```
+    ./gradlew bootRun —args='—spring.profiles.active=local'
+    ```
 
-**Bold** and _Italic_ and `Code` text
 
-[Link](url) and ![Image](src)
-```
+#### Frontend
+
+- Prerequisite
+  - [Flutter 3.13.0](https://docs.flutter.dev/get-started/install)
+  - [Dart 3.1.0](https://dart.dev/get-dart)
+  - [안드로이드 스튜디오](https://developer.android.com/codelabs/basic-android-kotlin-compose-install-android-studio?hl=ko#0)
+
+- 에뮬레이터 (혹은 시뮬레이터) 실행
+  - 안드로이드 스튜디오에서 device manager → virtual → create device → 실행
+
+- 로컬 실행하기
+  - 프론트엔드 파일 경로로 진입
+
+    ```
+    cd frontend
+    ```
+  - 패키지 설치
 
-자세한 내용은 [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/).
+    ```
+    flutter pub get
+    ```
+  - 프로젝트 실행
 
-### Support or Contact
+    ```
+    flutter run
+    ```
+### 7. Document
 
-readme 파일 생성에 추가적인 도움이 필요하면 [도움말](https://help.github.com/articles/about-readmes/) 이나 [contact support](https://github.com/contact) 을 이용하세요.
+- [중간 보고서](https://github.com/kookmin-sw/capstone-2024-07/files/15328640/default.pdf)
+- [중간 발표자료](https://github.com/kookmin-sw/capstone-2024-07/files/15328685/default.pdf)
+- [최종 포스터](https://github.com/kookmin-sw/capstone-2024-07/files/15368233/default.pdf)
+- [최종 발표자료](https://github.com/kookmin-sw/capstone-2024-07/files/15368652/-.pptx)
+- [수행결과보고서](https://github.com/kookmin-sw/capstone-2024-07/files/15329735/default.pdf)
+- [최종 보고서](https://github.com/kookmin-sw/capstone-2024-07/files/15426987/final.pdf)