v1.0.0

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,17 @@
+---
+name: Bug report
+about: 버그 이슈 템플릿
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## 📜 Bug Description
+<!-- 버그에 대해 설명해주세요. -->
+
+## 🐞 Bug Condition
+<!-- 버그 발생 조건을 알려주세요. -->
+
+## 📷 Bug Screenshot
+<!-- 버그 스크린샷, 동영상을 첨부해주세요. -->

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,16 @@
+---
+name: Feature Request
+about: 기능 개발 이슈 템플릿
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## 🚀 About Issue 🚀
+<!-- 이슈에 대한 내용을 설명해주세요. -->
+
+
+## ✅ Todo 
+<!-- 해야 할 일들을 적어주세요. -->
+- [ ] todo !

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,9 @@
+## 👩‍💻 Contents
+<!-- 작업 내용을 적어주세요 -->
+
+## 📝 Review Note
+<!-- PR과정에서 든 생각이나 개선할 내용이 있다면 적어주세요. -->
+
+## 📣 Related Issue
+<!-- 관련 이슈를 적어주세요. -->
+- closed #

.gitignore

@@ -0,0 +1 @@
+.vscode

.vscode/launch.json

@@ -0,0 +1,14 @@
+{
+  "configurations": [
+    {
+      "type": "java",
+      "name": "Spring Boot-MainApplication<main>",
+      "request": "launch",
+      "cwd": "${workspaceFolder}",
+      "mainClass": "org.sopt.makers.crew.main.MainApplication",
+      "projectName": "main",
+      "args": "",
+      "envFile": "${workspaceFolder}/.env"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "java.configuration.updateBuildConfiguration": "automatic"
+}

README.md

@@ -48,20 +48,20 @@ $ npm run test:cov
 - DB GUI tool: pgAdmin4
 - ORM: TypeORM
 - API 문서: Swagger
-- 배포: AWS EC2, PM2
+- 배포: AWS EC2, Docker Compose
 - 인증: JWT
-- 테스트: Jest
-- 서버 프레임워크: NestJS
-- 웹서버 프레임워크: Nginx
-- 언어: typescript
+- 테스트: Jest, Unit5
+- 서버 프레임워크: NestJS, Spring
+- 웹서버 프레임워크: Caddy
+- 언어: typescript, Java
 
 # 아키텍처
 
 ## flow
 
-1. Nginx를 통해 HTTPS를 적용하고, HTTP로 들어오는 요청을 HTTPS로 리다이렉트한다.
-2. HTTPS로 들어온 요청을 Nginx가 받아서, Nginx는 요청을 받은 후에 해당 요청을 NodeJS 서버로 프록시한다.
-3. NodeJS 서버는 요청을 받아서, 요청에 맞는 Controller를 찾아서 해당 Controller에서 Service를 호출한다.
+1. Caddy를 통해 HTTPS를 적용하고, HTTP로 들어오는 요청을 HTTPS로 리다이렉트한다.
+2. HTTPS로 들어온 요청을 Caddy가 받아서, Caddy는 요청을 받은 후에 해당 요청을 NodeJS/Spring 서버로 리버스프록시한다.
+3. NodeJS/Spring 서버는 요청을 받아서, 요청에 맞는 Controller를 찾아서 해당 Controller에서 Service를 호출한다.
 4. Service에서 로직을 처리한 후에, Repository를 통해 DB에 접근한다.
 5. Repository는 DB에 접근해서 데이터를 가져온 후에, Service에게 데이터를 전달한다.
 6. Service는 Repository로부터 받은 데이터를 가공해서 Controller에게 전달한다.
@@ -161,14 +161,19 @@ bar # 예시 모듈
 ## 환경 변수
 
 - 환경 변수는 dev/prod 환경에 따라 다르게 설정되어야 한다.
-  - dev 환경: .dev.env
-  - prod 환경: .prod.env
+  - Nestjs
+    - dev 환경: .dev.env
+    - prod 환경: .prod.env
+  - Spring
+    - dev 환경: application-dev.yml
+    - prod 환경: application-prod.yml
+    - application-secret.properties: secret key를 관리한다.
 
 ## API 문서
 
 - `/api-docs`로 접속하면 볼 수 있다.
-- [Crew API Docs - Dev](https://crew.api.dev.sopt.org/api-docs)
-- [Crew API Docs - Prod](https://crew.api.prod.sopt.org/api-docs)
+- [Crew API Docs - Dev](https://crew.api.dev.sopt.org/docs)
+- [Crew API Docs - Prod](https://crew.api.prod.sopt.org/docs)
 - [Playground API Docs - Dev](https://playground.dev.sopt.org/swagger-ui/index.html)
 
 ## 인증
@@ -189,20 +194,25 @@ bar # 예시 모듈
 ## 배포 정보
 
 - 배포 서버: AWS EC2
-- 배포 툴: PM2
+- 배포 툴: Docker Compose
 
 ## 배포 방법
 
 ```bash
-  # build
-  # 현재 서버에서 빌드를 하면 메모리가 부족해서 빌드가 안되기 때문에 임시방편 조치이다. CI/CD를 이용해 해결해야 한다.
-  $ NODE_OPTIONS=--max-old-space-size=2048 npm run build
+# Prod 배포
+$ sudo docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d --build
 
-  # build를 배포
-  $ pm2 restart 0
+# Dev 배포
+$ sudo docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d --build
 
-  # 배포된 이후 로그를 확인해서 제대로 배포되었는지 확인
-  $ pm2 log
+# 배포 후 로그 확인
+$ sudo docker compose logs -f -t 10
+
+# 배포 후 컨테이너 상태 확인
+$ sudo docker compose ps -a
+
+# 배포 후 사용하지 않는 이미지 자동 삭제
+$ sudo docker image prune
 ```
 
 # 협업

docker-compose.dev.yml

@@ -0,0 +1,18 @@
+version: "3.7"
+
+services:
+  swagger:
+    labels:
+      caddy: localhost crew.api.dev.sopt.org www.crew.api.dev.sopt.org
+
+  spring:
+    environment:
+      - SPRING_PROFILES_ACTIVE=dev
+    labels:
+      caddy: localhost crew.api.dev.sopt.org www.crew.api.dev.sopt.org
+
+  nestjs:
+    environment:
+      - NODE_ENV=dev
+    labels:
+      caddy: localhost crew.api.dev.sopt.org www.crew.api.dev.sopt.org

docker-compose.local.yml

@@ -0,0 +1,18 @@
+version: "3.7"
+
+services:
+  swagger:
+    labels:
+      caddy: localhost
+
+  spring:
+    environment:
+      - SPRING_PROFILES_ACTIVE=dev
+    labels:
+      caddy: localhost
+
+  nestjs:
+    environment:
+      - NODE_ENV=dev
+    labels:
+      caddy: localhost

docker-compose.prod.yml

@@ -0,0 +1,18 @@
+version: "3.7"
+
+services:
+  swagger:
+    labels:
+      caddy: localhost crew.api.prod.sopt.org www.crew.api.prod.sopt.org
+
+  spring:
+    environment:
+      - SPRING_PROFILES_ACTIVE=prod
+    labels:
+      caddy: localhost crew.api.prod.sopt.org www.crew.api.prod.sopt.org
+
+  nestjs:
+    environment:
+      - NODE_ENV=prod
+    labels:
+      caddy: localhost crew.api.prod.sopt.org www.crew.api.prod.sopt.org

docker-compose.yml

@@ -0,0 +1,119 @@
+version: "3.7"
+
+services:
+  caddy:
+    container_name: caddy
+    image: lucaslorentz/caddy-docker-proxy:ci-alpine
+    ports:
+      - 80:80
+      - 443:443
+    environment:
+      - CADDY_INGRESS_NETWORKS=caddy
+    networks:
+      - caddy
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock
+    logging:
+      driver: "json-file"
+      options:
+        max-size: "10m"
+        max-file: "10"
+    restart: unless-stopped
+
+  swagger:
+    image: swaggerapi/swagger-ui
+    container_name: swagger
+    environment:
+      - URLS=
+        [
+        {url:'/api-docs/json', name:'spring'},
+        {url:'/api-docs-json', name:'nestjs'},
+        ]
+      - BASE_URL=/docs
+    depends_on:
+      - nestjs
+      - spring
+    networks:
+      - caddy
+    logging:
+      driver: "json-file"
+      options:
+        max-size: "10m"
+        max-file: "10"
+    labels:
+      caddy.route: /docs*
+      caddy.route.reverse_proxy: "{{ upstreams 8080 }}"
+
+  spring:
+    build:
+      context: ./main
+      dockerfile: Dockerfile
+    container_name: spring
+    restart: unless-stopped
+    depends_on:
+      - nestjs
+    logging:
+      driver: "json-file"
+      options:
+        max-size: "10m"
+        max-file: "10"
+    networks:
+      - caddy
+    labels:
+      # for Swagger spec
+      caddy.route_0: /api-docs/json
+      caddy.route_0.reverse_proxy: "{{ upstreams 4000 }}"
+      # for health check
+      caddy.route_1: /health
+      caddy.route_1.reverse_proxy: "{{ upstreams 4000 }}"
+      caddy.route_2: /user/v2
+      caddy.route_2.reverse_proxy: "{{ upstreams 4000 }}"
+      caddy.route_3: /user/v2/*
+      caddy.route_3.reverse_proxy: "{{ upstreams 4000 }}"
+
+  nestjs:
+    build:
+      context: ./server
+      dockerfile: Dockerfile
+    container_name: nestjs
+    restart: unless-stopped
+    networks:
+      - caddy
+    logging:
+      driver: "json-file"
+      options:
+        max-size: "10m"
+        max-file: "10"
+    labels:
+      # for Swagger spec
+      caddy.route_0: /api-docs-json
+      caddy.route_0.reverse_proxy: "{{ upstreams 3000 }}"
+      # for health check
+      caddy.route_1: /
+      caddy.route_1.reverse_proxy: "{{ upstreams 3000 }}"
+      caddy.route_2: /auth
+      caddy.route_2.reverse_proxy: "{{ upstreams 3000 }}"
+      caddy.route_3: /comment/v1
+      caddy.route_3.reverse_proxy: "{{ upstreams 3000 }}"
+      caddy.route_4: /comment/v1/*
+      caddy.route_4.reverse_proxy: "{{ upstreams 3000 }}"
+      caddy.route_5: /meeting
+      caddy.route_5.reverse_proxy: "{{ upstreams 3000 }}"
+      caddy.route_6: /meeting/*
+      caddy.route_6.reverse_proxy: "{{ upstreams 3000 }}"
+      caddy.route_7: /notice/v1
+      caddy.route_7.reverse_proxy: "{{ upstreams 3000 }}"
+      caddy.route_8: /notice/v1/*
+      caddy.route_8.reverse_proxy: "{{ upstreams 3000 }}"
+      caddy.route_9: /post/v1
+      caddy.route_9.reverse_proxy: "{{ upstreams 3000 }}"
+      caddy.route_10: /post/v1/*
+      caddy.route_10.reverse_proxy: "{{ upstreams 3000 }}"
+      caddy.route_11: /users
+      caddy.route_11.reverse_proxy: "{{ upstreams 3000 }}"
+      caddy.route_12: /users/*
+      caddy.route_12.reverse_proxy: "{{ upstreams 3000 }}"
+
+networks:
+  caddy:
+    external: true

main/.gitignore

@@ -0,0 +1,39 @@
+HELP.md
+.gradle
+build/
+!gradle/wrapper/gradle-wrapper.jar
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+bin/
+!**/src/main/**/bin/
+!**/src/test/**/bin/
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+out/
+!**/src/main/**/out/
+!**/src/test/**/out/
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+
+### VS Code ###
+.vscode/
+
+application-secret.properties

main/Dockerfile

@@ -0,0 +1,10 @@
+FROM openjdk:17-jdk-slim AS build
+WORKDIR /app
+COPY . /app
+RUN ./gradlew build
+
+FROM openjdk:17-jdk-slim
+WORKDIR /app
+COPY --from=build /app/build/libs/*.jar app.jar
+
+ENTRYPOINT ["java","-jar","/app/app.jar"]