Skip to content

Commit 951c001

Browse files
authored
DOC: update README.md
1 parent 7eb1b13 commit 951c001

File tree

1 file changed

+82
-1
lines changed

1 file changed

+82
-1
lines changed

README.md

+82-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,82 @@
1-
# Vinyla_Server
1+
<div align="center" style="display:flex;"><img src="https://user-images.githubusercontent.com/41534832/173377044-d3666fa1-b929-4bfc-8db5-54481b1f3356.png" width="20%"><img src="https://user-images.githubusercontent.com/41534832/173381257-8c921a09-6ddf-493b-a92a-bb05d93fa50c.png" width="20%"></div>
2+
3+
4+
<div align="center">
5+
🎵 Vinyla: Work, Life, Vinyl 🎵
6+
</div>
7+
8+
<br><br>
9+
10+
```
11+
🧿 LP라고도 불리는 Vinyl은 현재 레트로 감성을 나타내는 대표적인 아이템입니다.
12+
13+
🧿 인테리어 소품이나 아이돌 굿즈 등으로도 쓰이고, 수집가들의 SNS에서도 활발히 볼 수 있어요.
14+
15+
🧿 Vinyl에 대한 관심과 수요를 기반으로 출시하는 Vinyl digger들을 위한 앱, Vinyla :)
16+
17+
🧿 Vinyl 수집가를 위한 모바일 Vinyl 보관함 서비스입니다.
18+
```
19+
20+
<br>
21+
22+
- - -
23+
24+
25+
### 🎧 Main Function
26+
- **홈 정보 조회**
27+
- 나의 대표 바이닐과 최근 저장한 4개의 바이닐을 확인할 수 있습니다.
28+
- 닉네임과 레벨을 확인할 수 있습니다.
29+
- 현재까지 수집한 바이닐 개수와 가장 많이 수집한 바이닐의 장르를 확인할 수 있습니다.
30+
- **바이닐 검색**
31+
- Discogs Open API를 이용해 제목 또는 아티스트명으로 바이닐 검색을 할 수 있습니다.
32+
- 바이닐 상세 조회를 통해 이미지, 아티스트명, 제목, 수록곡, 장르 등을 확인할 수 있습니다.
33+
- 서비스 내 다른 유저들의 추천 지수를 확인할 수 있습니다.
34+
- **보관함에 저장**
35+
- 오프라인에서 수집한 바이닐을 검색 후 보관함에 저장합니다.
36+
- 바이닐에 대한 추천 지수(별점)와 한줄평을 작성 후 보관함에 저장합니다.
37+
- **내 보관함**
38+
- 보관한 내 바이닐들을 확인할 수 있습니다.
39+
- 대표 바이닐을 수정할 수 있습니다.
40+
- **바이닐 요청**
41+
- 검색했지만 나오지 않는 바이닐을 요청할 수 있습니다.
42+
- 운영자가 확인할 수 있는 참고용 이미지와 제목, 아티스트명, 메모 등을 포함해 요청을 등록합니다.
43+
- (개발중) 운영자용 웹 페이지를 통해 들어온 요청을 처리하고, DB에 등록되면 해당 바이닐을 요청한 사용자에게 알림을 보내줍니다.
44+
- **회원가입/로그인**
45+
- Apple, Google, Facebook을 통해 소셜 로그인을 할 수 있습니다.
46+
- 회원가입 시 고유한 닉네임을 설정하고 마케팅 수신 동의 여부를 선택합니다.
47+
48+
49+
### 🎧 Dependencies
50+
```json
51+
"dependencies": {
52+
"cookie-parser": "~1.4.4",
53+
"crypto": "^1.0.1",
54+
"debug": "~2.6.9",
55+
"disconnect": "^1.2.2",
56+
"express": "~4.16.1",
57+
"http-errors": "~1.6.3",
58+
"jade": "~1.11.0",
59+
"jsonwebtoken": "^8.5.1",
60+
"morgan": "~1.9.1",
61+
"multer": "^1.4.4",
62+
"nodemon": "^2.0.7",
63+
"pbkdf2": "^3.1.2",
64+
"promise-mysql": "^5.0.3",
65+
"rand-token": "^1.0.1",
66+
"request": "^2.88.2",
67+
"xml-js": "^1.6.11"
68+
}
69+
```
70+
71+
### 🎧 ERD
72+
73+
<div align="center" style="display:flex;"><img src="https://user-images.githubusercontent.com/41534832/173386405-8d79ac3d-8496-409f-bb1c-9b76abb2ee59.png" width="85%"></div>
74+
75+
76+
### 🎧 Skills
77+
<img alt="Node.js" src ="https://img.shields.io/badge/Node.js-339933?&style=for-the-badge&logo=Node.js&logoColor=white"/><img alt="JavaScript" src ="https://img.shields.io/badge/JavaScript-F7DF1E?&style=for-the-badge&logo=JavaScript&logoColor=black"/><img alt="MariaDB" src ="https://img.shields.io/badge/MariaDB-003545?&style=for-the-badge&logo=MariaDB&logoColor=white"/><img alt="npm" src ="https://img.shields.io/badge/npm-CB3837?&style=for-the-badge&logo=npm&logoColor=white"/><img alt="Amazon AWS" src ="https://img.shields.io/badge/Amazon AWS-232F3E?&style=for-the-badge&logo=MySQL&logoColor=white"/><img alt="Nodemon" src ="https://img.shields.io/badge/Nodemon-76D04B?&style=for-the-badge&logo=Nodemon&logoColor=white"/>
78+
79+
<br>
80+
81+
#### [API 명세서 바로가기❗️](https://github.com/VinylaCrew/Vinyla_Server/wiki)
82+

0 commit comments

Comments
 (0)