Skip to content

Commit fd15139

Browse files
committed
[Film/#85] update README.md (#89)
* Update README.md
1 parent 3ffa5e0 commit fd15139

File tree

5 files changed

+143
-35
lines changed

5 files changed

+143
-35
lines changed

README.md

+106-35
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,68 @@
1-
# FILM
1+
# FILM📸
22

3-
## **프로젝트 설명**
3+
<br />
44

5-
**프로젝트 Film**을 통해 우리는 특별한 시간을 보낸 ***장소***에 기록(필름)을 남기고, 함께 ***시간***을 보낸 사람과 추억(필름)을 공유하여 시공간을 넘은 소통을 할 수 있다.
5+
## 🔗서비스 주소
66

7+
링크 : [https://d3hatotnvqhqmx.cloudfront.net/](https://d3hatotnvqhqmx.cloudfront.net)
8+
9+
<br />
10+
11+
## 👨‍👨‍👧‍👧팀원 소개
12+
13+
<table>
14+
<tr>
15+
<td align="center"><a href="https://github.com/2sjeong918"><img src="https://user-images.githubusercontent.com/70435257/146951570-1950d244-bbd4-439a-bb23-24a513ac72a0.png" width="150px" /></a></td>
16+
<td align="center"><a href="https://github.com/palsa131"><img src="https://user-images.githubusercontent.com/70435257/146951411-73f25a1b-ead5-48dd-8296-e9a652200b90.png" width="150px" /></a></td>
17+
<td align="center"><a href="https://github.com/jinn2u"><img src="https://user-images.githubusercontent.com/70435257/146951645-2939ca58-b1ef-4623-a105-12759efd1291.png" width="150px" /></a></td>
18+
<td align="center"><a href="https://github.com/iyj6707"><img src="https://user-images.githubusercontent.com/70435257/146951725-5222c696-e5c9-45ec-b097-9d39213f3a6b.png" width="150px" /></a></td>
19+
<td align="center"><a href="https://github.com/16min99"><img src="https://user-images.githubusercontent.com/70435257/146951967-8c757ca2-2549-4377-9e06-41cfd0543b9a.png" width="150px" /></a></td>
20+
<td align="center"><a href="https://github.com/jungeu1509"><img src="https://user-images.githubusercontent.com/70435257/146952077-86199ea8-d1b9-4a00-a468-36ee1c5d7b93.png" width="150px" /></a></td>
21+
</tr>
22+
<tr>
23+
<td align="center"><b>이소정</b></td>
24+
<td align="center"><b>김정호</b></td>
25+
<td align="center"><b>강동진</b></td>
26+
<td align="center"><b>임연재</b></td>
27+
<td align="center"><b>전민규</b></td>
28+
<td align="center"><b>정은우</b></td>
29+
</tr>
30+
<tr>
31+
<td align="center"><b>Product Owner</b></td>
32+
<td align="center"><b>FE Developer</b></td>
33+
<td align="center"><b>FE Developer</b></td>
34+
<td align="center"><b>Scrum Master</b></td>
35+
<td align="center"><b>BE Developer</b></td>
36+
<td align="center"><b>BE Developer</b></td>
37+
</tr>
38+
</table>
39+
40+
<br />
41+
42+
## 📄**프로젝트 설명**
43+
44+
사람들마다 특별한 시간을 보낸 특별한 장소가 있다.
45+
46+
이런 추억을 공간에 남겨 그 곳을 다시 방문할 때 열어볼 수 있고, 함께했던 사람과 공유할 수 있으면 어떨까?
47+
48+
49+
**[프로젝트 Film]** 을 통해 우리는 특별한 시간을 보낸 ***장소***에 기록(필름)을 남기고, 함께 ***시간***을 보낸 사람과 추억(필름)을 공유하여 시공간을 넘은 소통을 할 수 있다.
50+
51+
<br />
52+
53+
## **기대 효과**
54+
55+
- 코로나로 인해 주위 사람들을 자주 만나지 못하는 지금, `코로나 블루` 라는 새로운 현상도 생겨나고 있다.
56+
- 이러한 상황에서 본 서비스는 주변 사람들 또는 나 자신과의 유대감을 높여주는데 목적이 있다.
57+
- 단순히 사진과 장소를 확인할 수 있는 기존의 갤러리 또는 클라우드와는 다르게 `다른 사람들과의 공유` 또는 `나 자신과의 공유` 를 통해 그날의 기억을 온전히 기록함으로써 보다 더 그날의 기억을 또렷히 기억하고자 하였다.
58+
- 따라서 시간이 지날수록 흐려져가는 추억이 아니라 추억에 대해 이야기 했던 기록들도 간직함으로써 힘들 때 혹은 지칠 때 버팀목이 되어 줄 수 있는 서비스가 되고자 노력하였다.
59+
- 또한 미래에 확인할 수 있는 `필름 생성` 기능을 통하여 본인 혹은 함께 하고싶은 사람 앞으로의 추억을 연결하고자 하였다.
60+
- 이로 인해 과거의 추억을 특별한 때에 다시 상기시킬 수 있으며, 같은 장소에서의 추억을 다른 누군가와 공유함으로써 그 장소를 한층 더 특별한 공간으로 만들어주도록 하였다.
61+
- 본 서비스를 통해 우리가 사진들로만 간직할 수 밖에 없었던 기억들을 보다 입체적으로 간직하여 바쁜 삶을 살아가는 현대인들에게 나무같은 존재가 되고자 한다.
62+
63+
<br />
64+
65+
## 👏주요 기능 소개
766
<table align="center">
867
<tr>
968
<td align="center">최초 개봉, 열람 삭제</td>
@@ -31,41 +90,53 @@
3190
</tr>
3291
</table>
3392

34-
## 서비스 주소
93+
# 백엔드 프로젝트 개요
3594

36-
[https://d3hatotnvqhqmx.cloudfront.net/](https://d3hatotnvqhqmx.cloudfront.net/)
95+
## 개발환경
96+
- 언어
97+
- Java 17
98+
- 라이브러리
99+
- Spring Boot 2.5.6
100+
- jpa 2.6.1 hibernate
101+
- AWS SDK
102+
- Database
103+
- H2 2.0.202
104+
- MySQL 8.0.25
105+
- CI/CD
106+
- github actions
107+
- 배포 환경
108+
- AWS EC2 / S3
109+
- 문서화
110+
- Restdocs
37111

38-
## 팀원 소개
112+
## Entity Relationship Diagram
39113

40-
<table>
41-
<tr>
42-
<td align="center"><a href="https://github.com/2sjeong918"><img src="https://user-images.githubusercontent.com/70435257/146951570-1950d244-bbd4-439a-bb23-24a513ac72a0.png" width="150px" /></a></td>
43-
<td align="center"><a href="https://github.com/palsa131"><img src="https://user-images.githubusercontent.com/70435257/146951411-73f25a1b-ead5-48dd-8296-e9a652200b90.png" width="150px" /></a></td>
44-
<td align="center"><a href="https://github.com/jinn2u"><img src="https://user-images.githubusercontent.com/70435257/146951645-2939ca58-b1ef-4623-a105-12759efd1291.png" width="150px" /></a></td>
45-
<td align="center"><a href="https://github.com/iyj6707"><img src="https://user-images.githubusercontent.com/70435257/146951725-5222c696-e5c9-45ec-b097-9d39213f3a6b.png" width="150px" /></a></td>
46-
<td align="center"><a href="https://github.com/16min99"><img src="https://user-images.githubusercontent.com/70435257/146951967-8c757ca2-2549-4377-9e06-41cfd0543b9a.png" width="150px" /></a></td>
47-
<td align="center"><a href="https://github.com/jungeu1509"><img src="https://user-images.githubusercontent.com/70435257/146952077-86199ea8-d1b9-4a00-a468-36ee1c5d7b93.png" width="150px" /></a></td>
48-
</tr>
49-
<tr>
50-
<td align="center"><b>이소정</b></td>
51-
<td align="center"><b>김정호</b></td>
52-
<td align="center"><b>강동진</b></td>
53-
<td align="center"><b>임연재</b></td>
54-
<td align="center"><b>전민규</b></td>
55-
<td align="center"><b>정은우</b></td>
56-
</tr>
57-
<tr>
58-
<td align="center"><b>Product Owner</b></td>
59-
<td align="center"><b>FE Developer</b></td>
60-
<td align="center"><b>FE Developer</b></td>
61-
<td align="center"><b>Scrum Master</b></td>
62-
<td align="center"><b>BE Developer</b></td>
63-
<td align="center"><b>BE Developer</b></td>
64-
</tr>
65-
</table>
114+
![ERD_Film](https://user-images.githubusercontent.com/52902010/146955622-70818c03-68ca-4827-a778-ea436136e681.png)
115+
116+
## CI/CD
117+
118+
![ci_cd](https://user-images.githubusercontent.com/52902010/146955932-c4a11bf7-444a-45aa-9b04-354e1b11d1a9.png)
119+
120+
## 구조
121+
122+
### 멀티모듈
123+
124+
[Multi Module](https://github.com/prgrms-web-devcourse/Team_17TOP_Film_BE/wiki/Multi-module)
125+
126+
### 로그인 구조
127+
128+
[Login](https://github.com/prgrms-web-devcourse/Team_17TOP_Film_BE/wiki/Login(OAuth-2.0,-Kakao-social-login))
129+
130+
## 협업 규칙
131+
132+
### 코드 작성
133+
[코드 작성 규칙](https://github.com/prgrms-web-devcourse/Team_17TOP_Film_BE/wiki/Code-Convention)
134+
135+
### Github 코드 관리
136+
[Github Project 규칙](https://github.com/prgrms-web-devcourse/Team_17TOP_Film_BE/wiki/%ED%98%91%EC%97%85-%EA%B7%9C%EC%B9%99(%EC%9D%B4%EC%8A%88,-%EB%B8%8C%EB%9E%9C%EC%B9%98,-%EC%BB%A4%EB%B0%8B,-PR))
66137

67-
## Github Repository
138+
## ⭐️Github Repository
68139

69-
프런트 : https://github.com/prgrms-web-devcourse/Team_17TOP_Film_FE
140+
프런트 : [Team_17TOP_Film_FE](https://github.com/prgrms-web-devcourse/Team_17TOP_Film_FE)
70141

71-
백엔드 : https://github.com/prgrms-web-devcourse/Team_17TOP_Film_BE
142+
백엔드 : [Team_17TOP_Film_BE](https://github.com/prgrms-web-devcourse/Team_17TOP_Film_BE)

film-api/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# film-common
2+
3+
사용자 서버 애플리케이션 모듈
4+
5+
- 스케쥴러
6+
- RestDocs
7+
8+
## 하위 모듈
9+
10+
- film-domain
11+
- film-external

film-common/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# film-common
2+
3+
전반 모듈에서 공통적으로 사용되는 모듈
4+
5+
- 커스텀 예외처리
6+
7+
## 하위 모듈
8+
9+
none

film-domain/README.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# film-domain
2+
3+
도메인 모듈
4+
5+
- Domain
6+
- Repository
7+
8+
## 하위 모듈
9+
10+
- film-common

film-external/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# film-external
2+
3+
외부 통신을 담당하는 모듈
4+
5+
## 하위 모듈
6+
7+
- film-common

0 commit comments

Comments
 (0)