Skip to content

Commit 344678d

Browse files
authored
Merge pull request #414 from TripInfoWeb/dev_readme
Docs: README.md 작성
2 parents f57732c + c2e68e2 commit 344678d

File tree

4 files changed

+293
-23
lines changed

4 files changed

+293
-23
lines changed
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Bug Report
3+
about: 어떤 버그인지 설명해 주세요.
4+
title: "Bug: 버그 설명"
5+
labels: Bug
6+
assignees: ""
7+
---
8+
9+
## ❓ 어떤 버그인가요?
10+
11+
- 어떤 버그인지 설명해 주세요.
12+
13+
## 🖥️ 발생 환경
14+
15+
- OS: (Ex. Windows, macOS, Ubuntu)
16+
- 브라우저: (Ex. Chrome, Firefox)
17+
- 버전: (Ex. v1.0.3)
18+
19+
## 🕘 발생 일시
20+
21+
- 버그가 발생한 날짜와 시간을 입력해 주세요. (Ex. 2024년 10월 1일, 오후 3시 30분)
22+
23+
## 📝 예상 결과
24+
25+
- 예상했던 정상적인 결과가 어떤 것이었는지 설명해주세요
26+
27+
## 📚 참고할만한 자료(선택)
28+
29+
- 추가적으로 참고할 만한 사항이 있으면 적어주세요.
30+
- 없는 경우 해당 단락을 삭제해 주세요.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Feature Request
3+
about: 새로운 기능 추가 요청을 작성해 주세요.
4+
title: "Feat: 기능 설명"
5+
labels: Feat
6+
assignees: ""
7+
---
8+
9+
## ❓ 어떤 기능인가요?
10+
11+
- 추가 요청하려는 기능에 대해 설명해 주세요.
12+
13+
## 📝 기능 설명
14+
15+
- 추가하려는 기능의 세부 설명 및 목적을 작성해 주세요.
16+
17+
## ✅ TODO
18+
19+
구현해야 하는 기능에 대해 체크리스트를 작성해 주세요.
20+
21+
- [ ] TODO 1
22+
- [ ] TODO 2
23+
24+
## 📚 참고할만한 자료(선택)
25+
26+
- 추가적으로 참고할 만한 사항이 있으면 적어주세요.
27+
- 없는 경우 해당 단락을 삭제해 주세요.

.github/pull_request_template.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
- 제목: Feat: 기능명
2+
Ex. Feat: pull request template 작성
3+
4+
-- 절취선 위 부분의 내용은 모두 삭제하고 PR을 작성해 주세요. --
5+
6+
---- 절취선 ----
7+
8+
## ☑️ 개발 유형
9+
10+
- [x] Front-end
11+
12+
## ✔️ PR 유형
13+
14+
- [ ] 새로운 기능 추가
15+
- [ ] 버그 수정
16+
- [ ] CSS 등 사용자 UI 디자인 변경
17+
- [ ] 기존 기능에 영향을 주지 않는 변경사항 (Ex. 오타 수정, 탭 사이즈 변경, 변수명 변경, 코드 리팩토링 등)
18+
- [ ] 주석 관련 작업
19+
- [ ] 문서 관련 작업
20+
- [ ] 테스트 추가 혹은 테스트 리팩토링
21+
- [ ] 빌드 부분 혹은 패키지 매니저 수정
22+
- [ ] 파일 혹은 폴더명 수정
23+
- [ ] 파일 혹은 폴더 삭제
24+
25+
## 📝 작업 내용
26+
27+
이번 PR에서 작업한 내용을 간략히 설명해주세요.
28+
29+
- [x] 구현한 기능 1
30+
- [x] 구현한 기능 2
31+
32+
## #️⃣ Related Issue
33+
34+
해당 Pull Request과 관련된 Issue Link를 작성해 주세요
35+
36+
Ex. #123

README.md

Lines changed: 200 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,213 @@
1-
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
1+
<h1>Solitour - 새로운 나를 찾는 여행</h1>
22

3-
## Getting Started
3+
![image](https://github.com/user-attachments/assets/e65f5376-ecf0-4b69-aab0-df5920130856)
44

5-
First, run the development server:
5+
> 배포 링크 <br/> **https://www.solitourist.com**
66
7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
15-
```
7+
<br/>
168

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
9+
<div align="center">
1810

19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
11+
[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FTripInfoWeb%2Fsolitour-frontend&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://hits.seeyoufarm.com)
2012

21-
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
13+
</div>
2214

23-
## Learn More
15+
<br/>
16+
<br/>
2417

25-
To learn more about Next.js, take a look at the following resources:
18+
<h2>목차</h2>
2619

27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
20+
- [✅ 서비스 소개](#-서비스-소개)
21+
- [💾 주요 기능](#-주요-기능)
22+
- [메인 페이지](#메인-페이지)
23+
- [정보 목록 조회](#정보-목록-조회)
24+
- [정보 생성](#정보-생성)
25+
- [정보 상세 조회](#정보-상세-조회)
26+
- [정보 수정](#정보-수정)
27+
- [모임 목록 조회](#모임-목록-조회)
28+
- [모임 상세 조회](#모임-상세-조회)
29+
- [모임 수정](#모임-수정)
30+
- [모임 삭제](#모임-삭제)
31+
- [모임 참가](#모임-참가)
32+
- [로그인](#로그인)
33+
- [마이페이지](#마이페이지)
34+
- [고객지원](#고객지원)
35+
- [🏛️️ 아키텍처](#️️-아키텍처)
36+
- [📚 기술스택](#-기술스택)
37+
- [👤 팀원 소개](#-팀원-소개)
2938

30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
39+
<br/>
40+
<br/>
3141

32-
## Deploy on Vercel
42+
## ✅ 서비스 소개
3343

34-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
44+
- <b>Solitour(솔리투어)</b>는 사용자들이 여행한 정보를 기록하고 공유하여 여행 정보나 팁을 이미지와 함께 제공하거나, 사용자들이 모임 기간, 모임 마감일, 성별, 나이, 장소, 참여 인원 등을 설정하여 모임을 등록하고, 모임에 신청할 수 있는 서비스를 제공합니다. 또한 본인의 여행 기록을 남길 수 있는 서비스도 제공합니다.
45+
- 여행 정보
46+
- Solitour는 사용자들이 직접 작성한 여행 정보를 통해 혼자 여행하는 사람들에게 유용한 맛집, 숙박, 액티비티 정보를 제공합니다.
47+
- 이를 통해 혼자 여행하는 사람들이 경험에 기반한 신뢰할 수 있는 정보를 쉽게 얻을 수 있습니다.
48+
- 모임
49+
- 사용자들은 취미와 활동을 기반으로 모임을 생성하고 참여할 수 있습니다.
50+
- 이를 통해 평소에 혼자 즐기기 어려웠던 취미와 활동을, 공통의 관심사를 갖고 있던 사람들과 함께 즐길 수 있는 기회를 제공합니다.
51+
- 여행 일기
52+
- 사용자 자신의 여행 기억을 이미지와 감정을 함께 기록하고 일기 형식으로 남기면서 자신의 여행을 회고할 수 있는 서비스를 제공합니다.
3553

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
54+
<br/>
55+
<br/>
56+
57+
## 💾 주요 기능
58+
59+
### 메인 페이지
60+
61+
![](https://github.com/user-attachments/assets/e0a0440a-50bc-4d8b-947c-b59c37d768bf)
62+
63+
- 메인 페이지에서는 최근 3개월 내에 사람들이 많이 찾아본 여행 정보를 확인할 수 있습니다.
64+
- 또한 최근 모집 중인 모임에 대한 정보를 확인할 수 있습니다.
65+
66+
<br/>
67+
68+
### 정보 목록 조회
69+
70+
![정보 목록](https://github.com/user-attachments/assets/fb301714-e96b-4fbd-8d3e-3448d5a23386)
71+
72+
- 최근 3개월 내의 가장 인기 있는 여행 정보 글 Top 5를 확인할 수 있습니다.
73+
- 정보 목록 페이지에서는 작성된 여행 정보 목록을 확인할 수 있습니다.
74+
- 카테고리 별로 여행 정보 목록을 확인할 수 있습니다.
75+
- 제목 검색과 태그 검색 기능을 지원합니다.
76+
- 정보 글 목록을 최신순, 좋아요순, 조회순으로 조회할 수 있습니다.
77+
- 지역별 필터링 기능을 지원합니다.
78+
- 북마크 기능을 지원합니다.
79+
80+
<br/>
81+
82+
### 정보 생성
83+
84+
![정보생성](https://github.com/user-attachments/assets/ac722e12-4a78-494a-834f-e17120a9648f)
85+
86+
- 제목, 장소, 카테고리, 이미지, 내용, 해시태그, 정보 Tip을 등록할 수 있습니다.
87+
- 이미지는 최대 12개까지 등록할 수 있습니다.
88+
89+
<br/>
90+
91+
### 정보 상세 조회
92+
93+
![정보상세](https://github.com/user-attachments/assets/459ac4b2-ae8b-4ad6-958c-51c9c84673d5)
94+
95+
- 다른 사용자가 작성한 여행 상세 정보를 조회할 수 있습니다.
96+
- 좋아요수, 조회수를 확인할 수 있습니다.
97+
- 해당 정보 글에 댓글을 작성하거나 댓글 목록을 확인할 수 있습니다.
98+
- 동일한 카테고리에 속하는 추천 여행 정보 목록을 확인할 수 있습니다.
99+
100+
<br/>
101+
102+
### 정보 수정
103+
104+
![정보수정](https://github.com/user-attachments/assets/f7db717a-468c-4693-abc9-559e63f7fd2c)
105+
106+
- 자신이 작성한 정보 글을 수정할 수 있습니다.
107+
108+
<br/>
109+
110+
### 모임 목록 조회
111+
112+
![모임목록](https://github.com/user-attachments/assets/f89c666c-2e9f-4398-b9a9-4dc34764c6a0)
113+
114+
- 최근 3개월 내의 가장 인기 있는 모임 모집 글 Top 5를 확인할 수 있습니다.
115+
- 모임 목록 페이지에서는 현재 모집 중인 모임 목록을 확인할 수 있습니다.
116+
- 취미 또는 활동 별로 모임 목록을 확인할 수 있습니다.
117+
- 제목 검색과 태그 검색 기능을 지원합니다.
118+
- 모임 목록을 최신순, 좋아요순, 조회순으로 조회할 수 있습니다.
119+
- 지역별, 성별, 나이별, 기간별 필터링 기능을 지원합니다.
120+
- 북마크 기능을 지원합니다.
121+
122+
<br/>
123+
124+
### 모임 상세 조회
125+
126+
![모임상세](https://github.com/user-attachments/assets/e722c2f2-f3f8-431d-a991-a0355822dddd)
127+
128+
- 모임을 생성한 사용자는 현재 모임 참가 신청자 목록을 확인할 수 있습니다.
129+
- 모임 주최자는 모임 신청에 대해 승인 또는 거절을 할 수 있습니다.
130+
- 좋아요수, 조회수를 확인할 수 있습니다.
131+
- 동일한 카테고리에 속하는 추천 모임 목록을 확인할 수 있습니다.
132+
133+
<br/>
134+
135+
### 모임 수정
136+
137+
![모임수정](https://github.com/user-attachments/assets/0a2a5814-1d50-4e5e-a53b-b25f185751f8)
138+
139+
- 자신이 작성한 모임 글을 수정할 수 있습니다.
140+
141+
<br/>
142+
143+
### 모임 삭제
144+
145+
![모임삭제](https://github.com/user-attachments/assets/949caa51-6ff9-4e9e-91bc-3384aa869c8b)
146+
147+
- 자신이 작성한 모임 글을 삭제할 수 있습니다.
148+
149+
<br/>
150+
151+
### 모임 참가
152+
153+
![모임참가](https://github.com/user-attachments/assets/3b828ef2-6681-41b6-ab23-80c3c8bde21d)
154+
155+
- 사용자는 다른 사용자가 생성한 모임에 대해 참가 신청을 하거나 취소할 수 있습니다.
156+
157+
<br/>
158+
159+
### 로그인
160+
161+
![로그인](https://github.com/user-attachments/assets/5075bc9d-0a31-4029-bb0c-5252e5ad40bb)
162+
163+
- 사용자가 서비스를 쉽게 이용할 수 있도록 Kakao OAuth 로그인을 지원합니다.
164+
165+
<br/>
166+
167+
### 마이페이지
168+
169+
![마이페이지](https://github.com/user-attachments/assets/0a6febed-3694-4a38-a2bd-9c30bc3518ce)
170+
171+
- 마이페이지에서 자신이 작성한 정보 또는 모임 글을 확인할 수 있습니다.
172+
- 북마크한 정보 또는 모임 글을 확인할 수 있습니다.
173+
- 닉네임이나 프로필 이미지를 변경할 수 있습니다.
174+
- 서비스를 더 이상 이용하지 않을 경우 회원탈퇴 기능을 지원합니다.
175+
176+
<br/>
177+
178+
### 고객지원
179+
180+
![고객지원](https://github.com/user-attachments/assets/dad337af-e5a8-4bb3-8de4-e4c5a65f792f)
181+
182+
- 서비스 소개, 공지사항, FAQ, 이용약관 정보를 제공합니다.
183+
184+
<br/>
185+
<br/>
186+
187+
## 🏛️️ 아키텍처
188+
189+
![아키텍처](https://github.com/user-attachments/assets/68f28ee1-0651-463e-a26b-5238661a12a5)
190+
191+
<br/>
192+
<br/>
193+
194+
## 📚 기술스택
195+
196+
| 분류 | 기술 스택 |
197+
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
198+
| FE | ![](https://img.shields.io/badge/NPM-%23CB3837.svg?logo=npm&logoColor=white) ![](https://img.shields.io/badge/-Prettier-F7B93E?logo=prettier&logoColor=white) ![](https://img.shields.io/badge/ESLint-4B32C3?logo=eslint&logoColor=white) ![](https://img.shields.io/badge/TypeScript-3178C6?logo=TypeScript&logoColor=white) ![](https://img.shields.io/badge/Next.js-000000?logo=Next.js&logoColor=white) ![](https://img.shields.io/badge/Tailwind%20CSS-06B6D4?logo=tailwindcss&logoColor=white) ![Zustand](https://img.shields.io/badge/Zustand-443E38?logo=react&logoColor=ffffff) ![](https://img.shields.io/badge/-Zod-FF4154?logo=zod&logoColor=white) ![](https://img.shields.io/badge/React%20Hook%20Form-%23EC5990.svg?logo=reacthookform&logoColor=white) ![](https://img.shields.io/badge/Framer%20Motion-0055FF?logo=Framer&logoColor=white) |
199+
| BE | ![](https://img.shields.io/badge/Java-%23ED8B00.svg?logo=openjdk&logoColor=white) ![](https://img.shields.io/badge/Spring-6DB33F?logo=Spring&logoColor=white) ![](https://img.shields.io/badge/Spring%20Boot-6DB33F?logo=Spring%20Boot&logoColor=white) |
200+
| Database | ![](https://img.shields.io/badge/MySQL-4479A1?logo=mysql&logoColor=white) |
201+
| Infrastructure | ![](https://img.shields.io/badge/Vercel-000000?logo=Vercel&logoColor=white) ![](https://img.shields.io/badge/Nginx-%23009639.svg?logo=nginx&logoColor=white) ![](https://img.shields.io/badge/Amazon%20EC2-FF9900?logo=amazonec2&logoColor=white) ![](https://img.shields.io/badge/Amazon%20S3-569A31?logo=Amazon%20S3&logoColor=white) ![](https://img.shields.io/badge/Amazon%20RDS-527FFF?logo=Amazon%20RDS&logoColor=white) ![](https://img.shields.io/badge/GitHub%20Actions-2088FF?logo=GitHub%20Actions&logoColor=white) |
202+
| Collaboration Tools | ![](https://img.shields.io/badge/Figma-%23F24E1E.svg?logo=figma&logoColor=white) ![](https://img.shields.io/badge/-Notion-000000?logo=notion&logoColor=white) ![](https://img.shields.io/badge/-GitHub-181717?logo=github&logoColor=white) ![](https://img.shields.io/badge/-Slack-4A154B?logo=slack&logoColor=white) ![](https://img.shields.io/badge/Discord-5865F2?logo=Discord&logoColor=white) ![](https://img.shields.io/badge/Jira-0052CC?logo=Jira&logoColor=white) |
203+
204+
<br/>
205+
<br/>
206+
207+
## 👤 팀원 소개
208+
209+
| 김수아 | 노현진 | 이수경 | 원동훈 | 정재현 |
210+
| :-----------------: | :--------------------------------------------------------------------: | :-------------------------------------------------------------------: | :------------------------------------------------------------------: | :--------------------------------------------------------------------: |
211+
| | <img src="https://github.com/HyunJinNo.png" width="100" height="100"/> | <img src="https://github.com/ssssksss.png" width="100" height="100"/> | <img src="https://github.com/Astin01.png" width="100" height="100"/> | <img src="https://github.com/hyeonjaez.png" width="100" height="100"/> |
212+
| [email protected] | [@HyunJinNo](https://github.com/HyunJinNo) | [@ssssksss](https://github.com/ssssksss) | [@Astin01](https://github.com/Astin01) | [@hyeonjaez](https://github.com/hyeonjaez) |
213+
| Designer | Front-end | Front-end | Back-end | Back-end |

0 commit comments

Comments
 (0)