Skip to content

Commit

Permalink
docs: Update README.md(#156)
Browse files Browse the repository at this point in the history
  • Loading branch information
eastmeet authored Feb 2, 2023
1 parent 55b9cd1 commit 220609d
Showing 1 changed file with 218 additions and 11 deletions.
229 changes: 218 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,222 @@
# seb41_main_036
# 🙌 Intro
![Logo 1475e3023dc018c33f6a](https://user-images.githubusercontent.com/110949256/216314162-9e0877c9-e842-4ddb-9f27-b6a6f45f1302.png)

- `팀명` : 코드스테이츠 41기 36팀 장관이조
- `팀원` : 김진주(팀장), 이동우(서기), 정세민, 이상유, 박혜수, 이승현
- `도메인` : https://pikcha36.o-r.kr
- `기술발표` : https://youtu.be/cl04jBYgSjI
- `개발기간` : 2023. 1. 3. ~ 2023. 2. 3. (한달간)

### commit convention
- `feat`: A new feature
- `fix`: A bug fix
- `docs`: Changes to documentation
- `style`: Formatting, missing semi colons, etc; no code change
- `refactor`: Refactoring production code
- `test`: Adding tests, refactoring test; no production code change
- `chore`: Updating build tasks, package manager configs, etc; no production code change
</br>

------
### 기술 스택
# 🏠 About Pikcha
## 🖼️ Pikcha(픽차)?
<img src='https://user-images.githubusercontent.com/110949256/216342582-e72694f5-5cef-4ed1-a905-693966e0aa22.jpg' width='1000' height='600'>

`Pikcha`는 소중한 사람과 다녀온 기록을 기억할 수 있는 공간입니다.

쉬는날 가족, 친구 또는 연인과 어디를 가야할 지 잘 모른다면 Pikcha를 이용해보세요!

## 👀 왜 만들었을까요?
<img src='https://user-images.githubusercontent.com/110949256/216319316-9f4fe715-3a66-40a9-9f4b-a7b33dbe69b2.jpg' width='1500' height='600'>

`Pikcha`는 서울 내 명소가 어디인지 잘 모르는 당신을 위해 만들어졌습니다.

저희가 선별한 멋지고 아름다운 다양한 명소들을 방문해보세요.

## ⭐️ 기능
<img src='https://user-images.githubusercontent.com/110949256/216318488-7818ed30-9351-423b-9723-5bf8490d1317.jpg' width='1500' height='600'>

`포스팅`을 통해 자신이 다녀온 명소를 공유하고 사랑하는 사람들과 소통하세요.

다른 사람들이 올린 포스팅에 `좋아요`를 표시해보세요.

방문한 명소를 `즐겨찾기`해 소중한 기억을 간직하세요.

</br>

# 🌈 Team

## 👨‍👩‍👧‍👦 Members

|김진주 (팀장, FE) |정세민(FE)
:-----------------------------:|:-----------------------------:|
|<img src='https://user-images.githubusercontent.com/110949256/216304897-c5375a33-6090-4f89-8658-7cba77911300.png' width='150'>|<img src='https://user-images.githubusercontent.com/110949256/216307068-5d8c22f4-1328-4e67-bd0f-c7b0bb95a375.png' width='150'/>
|[@useusername1](https://github.com/useusername1) |[@MINSE97](https://github.com/MINSE97)

|박혜수 (FE) |이승현 (FE)
:-----------------------------:|:-----------------------------:|
|<img src='https://user-images.githubusercontent.com/110949256/216306552-08216ae2-f54e-4f9a-87e9-f18340319e8f.png' width='150'>|<img src='https://user-images.githubusercontent.com/110949256/216305538-65463170-bdb3-40c0-a84c-542bd33e5862.png' width='150'/>|>|
|[@namnam-5799](https://github.com/namnam-5799) |[@NowVic99](https://github.com/NowVic99) |

|이동우 (서기, BE) |이상유 (BE)
:-----------------------------:|:-----------------------------:|
|<img src='https://user-images.githubusercontent.com/110949256/216305396-eb9d78ae-5dee-43d3-aaf0-f00f43820e1d.png' width='150'>|<img src='https://user-images.githubusercontent.com/110949256/216305385-cad94960-3151-4738-82bb-2b4e4d7a1ff7.png' width='150'/>|>|
| [@eastmeet](https://github.com/eastmeet) | [@Sangyoo](https://github.com/Sangyoo) |

</br>

## 👑 Roles & Responsibility

| Name | Roles | Responsibility |
---------------------------------|--------------------------------|--------------------------------|
|김진주| Frontend | 헤더, 검색창 구현, 캐러셀, 실시간 랭킹 구현, 좋아요, 북마크 기능|
|정세민| Frontend | 명소 리스트 조회 및 필터링, 포스트 리스트 조회 및 필터링, 상세포스트 CRUD 기능 구현, 상세포스트 댓글 CRUD 기능 구현, 마이페이지 정보 CRUD 기능 구현|
|박혜수| Frontend | 지도 페이지 구현, 명소 상세 페이지 구현 |
|이승현| Frontend | 회원가입 및 로그인, 소셜 로그인, 로그아웃 페이지 및 로직, 토큰을 이용한 통신 로직 구현 (재발급 및 자동 로그아웃), 전역 상태 관리 |
|이동우| Backend | 회원가입 및 로그인, 소셜 로그인, 로그아웃, NginX 웹서버 구축, AWS 배포, SSL 보안, 멤버프로필, 댓글 도메인 구현|
|이상유| Backend | 명소, 포스트 도메인 구현, S3 이미지 업로드, 좋아요, 즐겨찾기, 필터링, 검색 기능|


</br>

# 💼 Document
### [Figma](https://www.figma.com/file/iFs2WMfNlUTOA6ILnCljk3/main-project?node-id=0%3A1&t=54AppbXG2IH2Ven1-1)

### [UserFlow](https://github.com/codestates-seb/seb41_main_036/wiki/UserFlow)

### [ERD](https://github.com/codestates-seb/seb41_main_036/wiki/ERD)

### [API 명세](https://documenter.getpostman.com/view/23682192/2s935hQmqG)

</br>

# 🛵 Development Tools
<img src="https://lh3.googleusercontent.com/pw/AMWts8BoQN19OS4K4QgDINS65jh193HCqKY6fXYRn7iChiJg0TANlkxvgnJU4pwHSkQsyJJreJ_uH-ywVfQ26CDIKnmhPONVvvSohKfWyP-JL36eXWHJ7sHJtux3onbwGD5xAQLrMOaOMl3Fj4-l8_IcXArc=w1311-h734-no?authuser=0" width="800" height="500">

</br>

# 🕹️ commit convention

`feat`: A new feature

`fix`: A bug fix

`docs`: Changes to documentation

`style`: Formatting, missing semi colons, etc; no code change

`refactor`: Refactoring production code

`test`: Adding tests, refactoring test; no production code change

`chore`: Updating build tasks, package manager configs, etc; no production code change

<br>

# :hamster: Pikcha 활용법!

<br>

## :mushroom: 1. 메인 페이지

<details>
<summary>메인</summary>
<div markdown="1">

|메인 페이지|
|:---:|
|<img src="https://user-images.githubusercontent.com/26656507/216332138-c559f162-9393-4ad2-a5ae-216a5948383a.gif" style="width:100%">

</div>
</details>

<br>
<details>
<summary>메인 명소 & 포스트</summary>
<div markdown="1">

|메인 명소| 메인 포스트 |
|:---:|:---:|
|<img src="https://user-images.githubusercontent.com/26656507/216332312-2f663ce7-20a7-4b12-870f-d7e8ca82514a.gif" style="width:100%">|<img src="https://user-images.githubusercontent.com/26656507/216332317-c5f0ffb2-822c-4f78-b07c-73f3ea5ef063.gif" style="width:100%">

</div>
</details>
<br>

## :herb: 2. 회원
<br>
<details>
<summary>&nbsp;회원가입&로그인</summary>
<div markdown="1">

|회원가입 | 로그인 |
|:---:|:---:|
|<img src="https://user-images.githubusercontent.com/26656507/216332396-43d4a4c3-ad09-4d98-87c8-d8446dca9fc9.gif" style="width:100%">|<img src="https://user-images.githubusercontent.com/26656507/216332303-1d9f3845-e4ad-4f8a-9448-51418c66644f.gif" style="width:100%">

</div>
</details>
<br>

## :blossom: 3. 회원 정보
<br>
<details>
<summary>&nbsp;마이페이지</summary>
<div markdown="1">

|마이 페이지|
|:---:|
|<img src="https://user-images.githubusercontent.com/26656507/216332307-34c3ec23-67f7-4f76-b91b-795b2b6ae41d.gif" style="width:100%">

</div>
</details>
<br>

## :cactus: 4. 명소

<br>
<details>
<summary>&nbsp;명소 페이지 & 명소 상세페이지</summary>
<div markdown="1">

|명소 페이지| 명소 상세페이지 |
|:---:|:---:|
|<img src="https://user-images.githubusercontent.com/26656507/216332367-4f8606cd-b08a-4968-9c3b-830c4da0868c.gif" style="width:100%">|<img src="https://user-images.githubusercontent.com/26656507/216332321-5d347864-588c-4821-89ec-c7a59c001556.gif" style="width:100%">

</div>
</details>

<br>
<details>
<summary>&nbsp;명소 검색 & 좋아요 & 즐겨찾기</summary>
<div markdown="1">

|명소 검색| 명소 좋아요, 즐겨찾기|
|:---:|:---:|
|<img src="https://user-images.githubusercontent.com/26656507/216332373-541d056e-c863-427c-8c68-b6d79bf9b198.gif" style="width:100%">|<img src="https://user-images.githubusercontent.com/26656507/216332361-99cf3ef8-5a9c-4846-99f3-bf7228ce2ae0.gif" style="width:100%">|

</div>
</details>
<br>

## :speech_balloon: 5. 포스트
<br>
<details>
<summary>포스트 페이지 & 상세 페이지</summary>
<div markdown="1">

|포스트 페이지| 포스트 상세페이지 |
|:---:|:---:|
|<img src="https://user-images.githubusercontent.com/26656507/216332392-ded69c5b-785c-441f-ab54-a7321a79b219.gif" style="width:100%">|<img src="https://user-images.githubusercontent.com/26656507/216332389-43b78105-3dfc-4401-876c-e48cd9ff0a80.gif" style="width:100%">

</div>
</details>

<br>
<details>
<summary>포스트 댓글달기 & 수정, 삭제</summary>
<div markdown="1">

|포스트 댓글등록|
|:---:|
|<img src="https://user-images.githubusercontent.com/26656507/216332379-f48a4166-c706-4807-9cbe-2d2f3240b800.gif" style="width:100%">

|포스트 댓글수정|
|:---:|
|<img src="https://user-images.githubusercontent.com/26656507/216332385-22c3d5b5-ec7b-4870-8f13-650af709b6af.gif" style="width:100%">

|포스트 댓글삭제|
|:---:|
|<img src="https://user-images.githubusercontent.com/26656507/216332382-06d5725c-66a8-4cec-8065-b98a20070371.gif" style="width:100%">
</div>
</details>

0 comments on commit 220609d

Please sign in to comment.