$$config title: 최종 프로젝트 기술서 작성 폼 keywords: - IT - ... $$

최종 프로젝트 저작거리팀 기술서

이미지, 파일, 일러스트 등 작가의 저작권을 거래하는 사이트 입니다.
상품을 산다는 느낌보다 작가의 저작권을 구매하여
2차 창작물에 저작권 문제없이 이용하기 위한 사이트입니다.

프로젝트 산출물

- [수행 계획서](https://docs.google.com/document/d/1V7bM2XYxu7EkGhZbJVqCWMAnz2-ZB-HnH5v0zYwDHnw/edit) - [요구사항 정의서](https://docs.google.com/spreadsheets/d/1nmhS-RS-fM3bxsDSZQvHo0j4eI9MO_rOOui5j_7jup0/edit#gid=0) - [사용자 화면 정의서(UI/UX)](https://ovenapp.io/view/HhgogXYDUk8PPgTuxloBDi8XyTQIWHaa/NHGvv) - [DB 설계 자료](https://slog.gg/p/12863) 진행 기간: 2023.08.08~ 2023.08.30

? 팀원

_{최기범(팀장)}

_문창빈

_김다은

_나현아

_김사랑

## 협업 Tool ### Trello ![Trello](https://i.imgur.com/H3THlkc.png) ## 목차 (본인 팀에 맞게 수정) - [? 배포 링크](#-배포-링크) - [? 사전 선발 과제](#-사전-선발-과제) - [브랜치 전략](#브랜치-전략) - [커밋 메시지 컨벤션](#커밋-메시지-컨벤션) - [? 팀 규칙](#-팀-규칙) - [? 폴더 구조](#-폴더-구조) - [?️ 기술 스택](#️-기술-스택) - [? 서비스 소개](#-서비스-소개) - [기능 구현](#기능-구현) - [페이지](#페이지) - [? 구현미리보기](#-구현미리보기)
## ? 배포 링크 |저작거리|[https://copyright.osoree.dev/](https://copyright.osoree.dev/)| ## ? 저작거리 github | 이름 | GitHub Repository | | ------ | --------------------------------------------------------------------------------- | |저작거리|[copyright_street](https://github.com/cojar/copyright_street)|
## ? 팀 규칙 ### 브랜치 전략 - main브런치는 default값으로 보존 - dev브런치에 각자 작업물 push 후 pr - pr 날린 코드 조원들의 승인 후 merge
## ? 폴더 구조 ``` ?copyright_street ? copyright_street └── ? rq ├── ? rsData └── ? security └── ? boundeContext ├── ? admin ├── ? article ├── ? artist ├── ? cart ├── ? email ├── ? file ├── ? hash ├── ? home ├── ? market ├── ? mamber ├── ? mambership ├── ? notice ├── ? payment ├── ? product ├── ? store ├── ? storeAnswer ├── ? storeQuestion └── ?market ?resources ├── ?static ├── ?templates └── ?application.properties ```
## ?️ 기술 스택

## ? 서비스 소개 (프로젝트 진행중) ### 기능 구현 - 메인페이지 - 라이센스 구매페이지
### 페이지 |**메인페이지**| | --- | # 이미지 예시 메인페이지 ![메인페이지](https://i.imgur.com/fqOmBMv.jpg) 회원가입 ![회원가입](https://i.imgur.com/4fHMgRJ.jpg) 로그인 ![로그인](https://i.imgur.com/yAyQ4AQ.jpg) 작가등록 ![작가등록](https://i.imgur.com/oDGpQho.jpg) 상품등록 ![상품등록](https://i.imgur.com/0oXNpkZ.jpg) ### ProductEntity ```java package com.sbp.copyrightStreet.boundedContext.product; import com.sbp.copyrightStreet.boundedContext.cart.Cart; import com.sbp.copyrightStreet.boundedContext.hash.Hash; import com.sbp.copyrightStreet.boundedContext.market.Market; import com.sbp.copyrightStreet.boundedContext.member.Member; import com.sbp.copyrightStreet.boundedContext.storequestion.Question; import jakarta.persistence.*; import lombok.Getter; import lombok.Setter; import lombok.ToString; import org.springframework.data.annotation.CreatedDate; import org.springframework.data.annotation.LastModifiedDate; import java.time.LocalDateTime; import java.util.List; @Getter @Setter @Entity public class Product { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) @Column private Long id; @Column private String name; @Column private int price; private int hitCount; @Column private String isActive; private String description;//설명 @ManyToOne private Member member; @OneToMany(mappedBy = "product", cascade = CascadeType.REMOVE) private List questionList; @OneToMany(mappedBy = "product", cascade = CascadeType.REMOVE) private List hashList; private String thumbnailImg; @OneToMany(mappedBy = "product", cascade = CascadeType.REMOVE) private List cartList; @CreatedDate private LocalDateTime createDate; @LastModifiedDate private LocalDateTime modifyDate; } ``` ### ProductController ```java @Controller @RequiredArgsConstructor @RequestMapping("/product") public class ProductController { private final ProductService productService; @GetMapping("/create") public String create(Model model){ List productList = this.productService.getList(); model.addAttribute("productList",productList); return "product/create"; } @PostMapping("/create") public String createContent(@RequestParam String name, @RequestParam String description,@RequestParam int price, MultipartFile thumbnail){ Long createdProductId = this.productService.create(name, description, price, thumbnail); return "redirect:/product/detail/" + createdProductId; } } ``` ### ProductService ```java @RequiredArgsConstructor @Service public class ProductService { private final ProductRepository productRepository; @Value("${custom.genFileDirPath}") private String genFileDirPath; public Long create(String name, String description, int price, MultipartFile thumbnail) { String thumbnailRelPath = "product/" + UUID.randomUUID().toString() + ".jpg"; File thumbnailFile = new File(genFileDirPath +"/" + thumbnailRelPath); thumbnailFile.mkdir(); try { thumbnail.transferTo(thumbnailFile); } catch(IOException e){ throw new RuntimeException(e); } Product p = new Product(); p.setName(name); p.setPrice(price); p.setDescription(description); p.setThumbnailImg(thumbnailRelPath); p.setCreateDate(LocalDateTime.now()); this.productRepository.save(p); Product createdProduct = this.productRepository.save(p); return createdProduct.getId(); } public Page getList(int page, String kw) { List sorts = new ArrayList<>(); sorts.add(Sort.Order.desc("createDate")); Pageable pageable = PageRequest.of(page, 30, Sort.by(sorts)); return this.productRepository.findAllByKeyword(kw, pageable); } } ``` ### ProductCreate.html ```html 상품등록

상품등록

``` 상품리스트 ![상품리스트](https://i.imgur.com/QrdvX0q.jpg) ### ProductController ```java @Controller @RequiredArgsConstructor @RequestMapping("/product") public class ProductController { private final ProductService productService; @GetMapping("/list") public String list(Model model, @RequestParam(value="page", defaultValue = "0") int page, @RequestParam(value="kw", defaultValue ="") String kw) { Page paging = productService.getList(page, kw); model.addAttribute("paging", paging); model.addAttribute("kw", kw); return "product/list"; } ``` ### ProductService ```java @RequiredArgsConstructor @Service public class ProductService { private final ProductRepository productRepository; @Value("${custom.genFileDirPath}") private String genFileDirPath; public Page getList(int page, String kw) { List sorts = new ArrayList<>(); sorts.add(Sort.Order.desc("createDate")); Pageable pageable = PageRequest.of(page, 30, Sort.by(sorts)); return this.productRepository.findAllByKeyword(kw, pageable); } public List getList() { return this.productRepository.findAll(); } ``` ### ProductList.html ```html

``` 상품디테일 ![상품디테일](https://i.imgur.com/duWPCCB.jpg) ### ProductController ```java @Controller @RequiredArgsConstructor @RequestMapping("/product") public class ProductController { private final ProductService productService; @GetMapping("/detail/{id}") public String detail(@PathVariable Long id, Model model) { Product product = productService.getProduct(id); System.out.println(product.toString()); model.addAttribute("product", product); return "product/detail"; } } ``` ### ProductService ```java @RequiredArgsConstructor @Service public class ProductService { private final ProductRepository productRepository; @Value("${custom.genFileDirPath}") private String genFileDirPath; public Product getProduct(Long id) { Optional product = this.productRepository.findById(id); if (product.isPresent()) { return product.get(); } else { throw new RuntimeException("product not found"); } } } ``` ### ProductDetail.html ```html 내 정보

돌아가기

상품상세정보

번호 {{product.id}}
상품명
가격 {{product.sale_price|intcomma}}원
등록날짜
수정날짜

질문등록

로그인 후 이용해주세요.

질문리스트

수정 삭제

질문이 없습니다

``` 장바구니 ![장바구니](https://i.imgur.com/LZSFv6h.jpg) 상품댓글리스트 ![상품 댓글리스트](https://i.imgur.com/wNNkunn.jpg) 라이센스 ![라이센스](https://i.imgur.com/6iSAd5g.jpg) 라이센스결제 ![라이센스결제](https://i.imgur.com/b4ZYG6A.jpg) 게시판 ![게시판](https://i.imgur.com/BnCUeBd.jpg) 글쓰기 ![글쓰기](https://i.imgur.com/cspnovY.jpg) 고객센터(일반회원) ![고객센터(일반회원)](https://i.imgur.com/7a3X77r.jpg) 고객센터(admin) ![고객센터(admin)](https://i.imgur.com/2MoEHY6.jpg) 마이페이지 ![마이페이지](https://i.imgur.com/f49w6qS.jpg) 등록된 작가 ![등록된작가](https://i.imgur.com/WDHj0jA.jpg) 등록된 회원 ![등록된회원](https://i.imgur.com/sJULJyg.jpg)

# ? 배포 ## ? 서버 구조 ![img](https://i.imgur.com/AspJjQQ.png)
$$uml !theme mars frame 클라이언트 { frame OS { frame 브라우저 { } } } frame 서버 { frame CentOS7 { circle CentOS7――3306 circle CentOS7――8083 circle CentOS7――443 frame 도커 { frame npm_1 { circle npm_1――443 } frame copyright { circle copyright――14641 } frame mariadb_1 { circle mariadb_1――3306 } } } } 브라우저 --> "CentOS7――443":1． https://www.copyright.osoree.dev 으로 접속 "CentOS7――443" --> "npm_1――443" : 2． 외부(CentOS7)의 443포트는\nnpm_1의 443포트로 연결되어 있다. "npm_1――443" --> "CentOS7――8083" : 3． npm_1이 도메인(copyright.osoree.dev)을 보고\n172．17．0．1:8083 으로 토스해야 겠다고 판단. "CentOS7――8083" --> "copyright――14641" : 4． 외부(CentOS7)의 8083포트는\ncopyright의 14641포트로 연결되어 있다. "copyright――14641" --> "CentOS7――3306" : 5． DB 쿼리, 내부 14641 => 외부 3306 "CentOS7――3306" --> "mariadb_1――3306" : 6． 외부 3306 => mariadb_1 내부 3306 $$
## ? Domains ![img](https://i.imgur.com/hXKtOUV.png)
## ? Naver Cloud PlatForm ![img](https://i.imgur.com/lKdzqVa.png)
### ? Pipeline Script --- ```java pipeline { agent any environment { timestamp = "${System.currentTimeMillis() / 1000L}" } stages { stage('Prepare') { steps { script { def oldImageId = sh(script: "docker images ogym:latest -q", returnStdout: true).trim() env.oldImageId = oldImageId } git branch: 'main', url: 'https://github.com/cojar/copyright_street' } post { success { sh 'echo "Successfully Cloned Repository"' } failure { sh 'echo "Fail Cloned Repository"' } } } stage('Build Gradle') { steps { dir('src/main/resources') { sh """ echo spring.profiles.include=prod > application.properties echo secret keys >> application-prod.properties """ } dir('.') { sh """ chmod +x gradlew """ } dir('.') { sh """ ./gradlew clean build """ } } post { success { sh 'echo "Successfully Build Gradle Test"' } failure { sh 'echo "Fail Build Gradle Test"' } } } stage('Build Docker Image') { steps { script { sh "docker build -t copyright:${timestamp} ." } } } stage('Run Docker Container') { steps { script { // Check if the container is already running def isRunning = sh(script: "docker ps -q -f name=ogym", returnStdout: true).trim() if (isRunning) { sh "docker rm -f copyright" } // Run the new container try { sh """ docker run \ --name=ogym \ -p 8083:14641 \ -v /docker_projects/copyright/volumes/file:/file \ --restart unless-stopped \ -e TZ=Asia/Seoul \ -d \ copyright:${timestamp} """ } catch (Exception e) { // If the container failed to run, remove it and the image isRunning = sh(script: "docker ps -q -f name=copyright", returnStdout: true).trim() if (isRunning) { sh "docker rm -f copyright" } def imageExists = sh(script: "docker images -q copyright:${timestamp}", returnStdout: true).trim() if (imageExists) { sh "docker rmi ogym:${timestamp}" } error("Failed to run the Docker container.") } // If there's an existing 'latest' image, remove it def latestExists = sh(script: "docker images -q ogym:latest", returnStdout: true).trim() if (latestExists) { sh "docker rmi copyright:latest" if(!oldImageId.isEmpty()) { sh "docker rmi ${oldImageId}" } } // Tag the new image as 'latest' sh "docker tag ogym:${env.timestamp} ogym:latest" } } } } } ```
### ? Deployment Process; Test Fail --- $$uml !theme toy autonumber box "작업PC" actor 개발자 entity 작업PC end box entity Github_Repository box "서버" entity Jenkins entity 테스트용_서버컨테이너 entity 실서버용_서버컨테이너 end box 개발자 -> 작업PC : Commit! 작업PC -> Github_Repository : Push! Github_Repository -> Jenkins : Webhook에 의해서 Commit Signal 전송 Jenkins -> 테스트용_서버컨테이너 : 재배포 스크립트 실행 테스트용_서버컨테이너 -> Jenkins : 테스트가 실패했습니다... Jenkins -> Jenkins : 이번 빌드는 실패로 처리하고, 작업을 종료합니다. 개발자 -> Jenkins : 해당 빌드의 콘솔기록을 확인하여 테스트가 왜 실패했는지 분석 $$
### ? Deployment Process; Test Success --- $$uml !theme toy autonumber box "작업PC" actor 개발자 entity 작업PC end box entity Github_Repository box "서버" entity Jenkins entity 테스트용_서버컨테이너 entity 실서버용_서버컨테이너 end box 개발자 -> 작업PC : Commit! 작업PC -> Github_Repository : Push! Github_Repository -> Jenkins : Webhook에 의해서 Commit Signal 전송 Jenkins -> 테스트용_서버컨테이너 : 재배포 스크립트 실행 테스트용_서버컨테이너 -> Jenkins : All Clear Jenkins -> 실서버용_서버컨테이너 : 리빌드 후 다시 실행하세요! 개발자 -> 실서버용_서버컨테이너 : Web Brouser로 Build 되었는지 확인 $$

최종 프로젝트 저작거리팀 기술서

프로젝트 산출물

? 팀원

상품등록

이상 저작거리팀의 스토리였습니다. 감사합니다.