Skip to content

Commit b303126

Browse files
ChooSeoyeonGyubam
ChooSeoyeon
and
Gyubam
authoredFeb 10, 2023
Update README.md (#191)
* Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Create README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md --------- Co-authored-by: Seo Gyu Bum <sgb8170@naver.com>
1 parent be7e594 commit b303126

File tree

1 file changed

+181
-1
lines changed

1 file changed

+181
-1
lines changed
 

‎README.md

+181-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,181 @@
1-
# 졸업 작품 거래 플랫폼
1+
<p align="middle" >
2+
<img width="200px;" src="https://user-images.githubusercontent.com/62178788/216916936-4ff2970f-6d8c-45e4-a306-1b6be76f2f70.svg"/>
3+
</p>
4+
<h1 align="middle">아띠즈</h1>
5+
<p align="middle">예비작가들의 예술작품을 저렴하게’ 라는 슬로건 아래 웹사이트 개발 프로젝트를 진행하는 팀입니다.</p>
6+
7+
## 프로젝트 소개 📝
8+
9+
졸업전시회까지 치열하게 준비하지만 막상 전시회가 끝난 후 미대생의 졸업작품이 일회성으로 끝나고 방치,폐기된다는 점이 아쉬웠습니다. 졸업작품을 거래할 수 있는 플랫폼을 만들어 컬렉터는 저렴한 비용으로 구입할 수 있고 미대생들은 경제적 수입과 함께 자신의 작품을 세상에 알릴 수 있는 소중한 기회를 갖게하는 것이 아띠즈의 목표입니다.
10+
<br>
11+
<br />
12+
13+
## 팀원 👨‍👨‍👧‍👧👩‍👦‍👦
14+
15+
| Backend | Backend | Backend | |
16+
| :------------------------------------: | :------------------------------------: | :--------------------------------: | --- |
17+
| <img src="https://avatars.githubusercontent.com/u/71515740?v=4" width=200px alt="Carrick"> | <img src="https://avatars.githubusercontent.com/u/83302344?v=4" width=200px alt="Choo"> | <img src="https://user-images.githubusercontent.com/62178788/217484706-f58f77bd-4554-4852-9d8e-506f465ea41d.jpeg" width=200px alt="Poo"> |
18+
| [Carrick](https://github.com/Gyubam) | [Choo](https://github.com/ChooSeoyeon) | [Poo](https://github.com/JunYoung) |
19+
| |
20+
<br>
21+
<br />
22+
23+
## ERD 🔨
24+
![image](https://user-images.githubusercontent.com/83302344/217729214-bb115b0a-78ec-4950-880f-fc4d13ebb96a.png)
25+
<br>
26+
<br />
27+
28+
## 프로젝트 기술스택 💡
29+
![image](https://user-images.githubusercontent.com/83302344/217729743-6add222b-e4c7-4936-aadd-79d5feb959c0.png)
30+
<br>
31+
<br />
32+
33+
## 프로젝트 아키텍쳐 🏛
34+
![image](https://user-images.githubusercontent.com/83302344/217729455-38630323-d050-478e-8a85-1e1b507c932e.png)
35+
<br>
36+
<br />
37+
38+
## 백엔드 배포 과정 (GithubActions 이용해 아래 과정에 대해 CI/CD 구축함)
39+
40+
### 로컬 : Gradle build, Docker build
41+
1. jar 빌드 : `gradle build`
42+
2. 이미지 생성 : `docker build -t 계정명/atties_spring ./`
43+
3. 도커 허브로 push : `docker push 계정명/atties_spring`
44+
45+
(`atties_spring`은 도커허브의 repository명)
46+
47+
### 서버 : Deploy
48+
1. 도커 허브에서 pull : `docker pull 계정명/atties_spring`
49+
2. 도커 yml에서 설정한 이미지 생성 : `docker tag 계정명/atties_spring atties_spring`
50+
3. 도커 컴포즈 실행 : `docker-compose up`
51+
<br>
52+
<br />
53+
54+
## Git 전략
55+
### 1) Git Workflow
56+
57+
### main → develop → feature/이슈번호-기능, fix/이슈번호-기능, refactor/이슈번호-기능
58+
59+
1. local - feature/이슈번호-기능 에서 각자 작업
60+
2. 작업 완료 후 remote - develop 에 PR
61+
3. 코드 리뷰 후 Approve 받고 Merge
62+
4. remote - develop 에 Merge 될 때 마다 모든 팀원 remote - develop pull 받아 최신 상태 유지
63+
</details>
64+
65+
### 2) Commit Convention
66+
67+
| 태그 이름 | 설명 |
68+
| ---------- | ------------------------------------------------------------------- |
69+
| feat | 새로운 기능에 대한 커밋 |
70+
| fix | 버그 수정에 대한 커밋 |
71+
| hotfix | issue나 QA에서 급한 버그 수정 |
72+
| build | 빌드 관련 파일 수정에 대한 커밋 |
73+
| chore | 그 외 자잘한 수정에 대한 커밋 |
74+
| style | 코드 스타일 혹은 포맷 등에 관한 커밋 |
75+
| docs | 문서 수정에 대한 커밋 |
76+
| test | 테스트 코드 수정에 대한 커밋 |
77+
| refactor | 코드 리팩토링에 대한 커밋 |
78+
<br>
79+
<br />
80+
81+
## 코딩 컨벤션
82+
83+
### 1) 네이밍 규칙
84+
85+
1. 변수나 함수, 클래스명은 `camelCase`를 사용한다.
86+
2. 함수의 경우 동사+명사 사용한다.
87+
88+
- ex) `getInfo()`
89+
90+
3. DB에 저장되는 컬럼명은 `snakeCase`를 사용한다.
91+
92+
- ex) `member_id`
93+
94+
4. Url 명은 `kebabCase`를 사용하며, 명사와 소문자로 구성한다.
95+
5. 구분자로 하이픈(-)을 사용하며, 되도록이면 구분자 없이 구성한다.
96+
97+
- ex) `www.example.com/user`
98+
99+
### 2) 빌더
100+
101+
1. 가독성 향상을 위해 생성자 대신 빌더를 필수적으로 사용한다.
102+
<br>
103+
<br />
104+
105+
## 전체 API 로직 구현 진척도 및 담당자
106+
107+
|기능|담당자|구현 여부|
108+
|---|---|---|
109+
|1. 회원관리|
110+
|[POST] 일반 회원가입 | Carrick | ✅ |
111+
|[POST] 로그인 | Carrick | ✅ |
112+
|[GET] 네이버 로그인 | Carrick | ✅ |
113+
|[GET] 카카오 로그인 | Carrick | ✅ |
114+
|[POST] Access Token 재발급 | Carrick | ✅ |
115+
|[POST] 로그아웃 | Carrick | ✅ |
116+
|[GET] email 중복 검사 | Carrick | ✅ |
117+
|[GET] id 중복 검사 | Carrick | ✅ |
118+
|[GET] nickname 중복 검사 | Choo | ✅ |
119+
|[POST] 임시 비밀번호 발급 | Poo | ✅ |
120+
|[POST] 아이디 찾기 메일 발송 | Choo | ✅ |
121+
|[PATCH] 비밀번호 변경 메일 발송 | Poo | ✅ |
122+
|[DELETE] 회원탈퇴 | Poo | ✅ |
123+
|2. 회원정보|
124+
|[PATCH] 작가 인증 파일 보내기 | Choo | ✅ |
125+
|[GET] 회원/작가 정보 조회 | Choo | ✅ |
126+
|[PATCH] 회원 정보 수정 | Choo | ✅ |
127+
|[PATCH] 작가 정보 수정 | Choo | ✅ |
128+
|[POST] 작가 픽하기 | Choo | ✅ |
129+
|[DELETE] 작가 픽 취소하기 | Choo | ✅ |
130+
|[GET] 픽작가 목록 조회 | Choo | ✅ |
131+
|[GET] 작가 상세 조회 | Choo | ✅ |
132+
|[POST] 작품 찜하기 | Carrick | ✅ |
133+
|[DELETE] 작품 찜 취소하기 | Carrick | ✅ |
134+
|[GET] 찜작품 목록 조회 | Carrick | ✅ |
135+
|[GET] 취향 작품 추천 목록 조회 | Choo | ✅ |
136+
|[PATCH] 관심 키워드 수정하기 | Carrick | ✅ |
137+
|3. 1:1 문의|
138+
|[GET] 1:1 문의 목록 조회 | Carrick | ✅ |
139+
|[POST] 1:1 문의하기 | Carrick | ✅ |
140+
|[PATCH] 1:1 문의 수정하기 | Carrick | ✅ |
141+
|[DELETE] 1:1 문의 삭제하기 | Carrick | ✅ |
142+
|4. 관리자|
143+
|[PATCH] 관리자 - 작가 프로필 전환 | Choo | ✅ |
144+
|[GET] 관리자 - 작가 인증 파일 목록 조회 | Choo | ✅ |
145+
|[PATCH] 관리자 - 1:1 문의 답변하기 | Choo | ✅ |
146+
|[GET] 관리자 - 1:1 문의 목록 조회 | Choo | ✅ |
147+
|[GET] 관리자 - 경매 배송 목록 조회 | Choo | ✅ |
148+
|[POST] 관리자 - 경매 생성 | Carrick | ✅ |
149+
|5. 작품|
150+
|[POST] 작품 등록 | Carrick | ✅ |
151+
|[GET] 등록 작품 목록 조회 | Carrick | ✅ |
152+
|[GET] 작품 상세 조회 | Carrick | ✅ |
153+
|[GET] 구매 작품 조회 | Carrick | ✅ |
154+
|6. 채팅|
155+
|[POST] 채팅방 생성 | Poo | ✅ |
156+
|[GET] 채팅방 조회 | Poo | ✅ |
157+
| 웹소켓 연결 | Poo | ✅ |
158+
| 채팅 송신 | Poo | ✅ |
159+
| 채팅방 구독 | Poo | ✅ |
160+
|[GET] 채팅방 목록 조회 | Poo | ✅ |
161+
|[DELETE] 채팅방 나가기 | Poo | ✅ |
162+
|7. 경매|
163+
|[PUT] 응찰하기 | Poo | ✅ |
164+
|[GET] 응찰 내역 조회 | Poo | ✅ |
165+
|[GET] 경매 목록 조회 | Carrick | ✅ |
166+
|[GET] 진행중 경매 작품 목록 조회 | Carrick | ✅ |
167+
|[GET] 종료된 경매 목록 조회 | Carrick | ✅ |
168+
|[GET] 종료된 경매의 작품 목록 조회 | Carrick | ✅ |
169+
|8. 알림|
170+
|[GET] 알림 목록 조회 | Choo | ✅ |
171+
|[DELETE] 알림 삭제 | Choo | ✅ |
172+
|[GET] 새로운 알림 유무 조회 | Choo | ✅ |
173+
|9. 전시|
174+
|[GET] 전시회 목록 조회 | Carrick | ✅ |
175+
|[GET] 전시회 조회 | Carrick | ✅ |
176+
|[GET] 특정 작품 전시회 조회 | Carrick | ✅ |
177+
|10. 검색|
178+
|[GET] 최근 검색어 조회 | Carrick | ✅ |
179+
|[DELETE] 최근 검색어 단일 삭제 | Carrick | ✅ |
180+
|[DELETE] 최근 검색어 전체 삭제 | Carrick | ✅ |
181+
|[GET] 작품 검색 | Carrick | ✅ |

0 commit comments

Comments
 (0)
Please sign in to comment.