https://github.com/stageus/dmap-backend-2
https://github.com/stageus/dmap-backend-2
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/stageus/dmap-backend-2
- Owner: Stageus
- Created: 2025-01-07T10:01:22.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-29T16:54:16.000Z (over 1 year ago)
- Last Synced: 2025-01-29T17:36:54.803Z (over 1 year ago)
- Language: JavaScript
- Size: 2.45 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ๐บ๏ธ D-Map Backend
## ๐ ํ๋ก์ ํธ ๊ฐ์
**D-Map ํ๋ก์ ํธ**๋ ์ฌ์ฉ์ ์์น ๊ธฐ๋ฐ์ **Playground ์๋น์ค**๋ก, ์ฌ์ฉ์๊ฐ ์์ ์ ์ด๋ ๊ฒฝ๋ก๋ฅผ ์ง๋ ์์ ๊ทธ๋ฆผ์ผ๋ก ํํํ๊ณ ์ด๋ฅผ ๊ณต์ ํ ์ ์๋ ๊ธฐ๋ฅ์ ์ ๊ณตํฉ๋๋ค.
**์ฃผ์ ๋ชฉํ:**
- ์ง๋ ๊ธฐ๋ฐ ํธ๋ํน์ ํ์ฉํ ์ฐฝ์์ ์ธ ์ฝํ
์ธ ์์ฑ
- ๊ณต์ ๋ฐ ์ข์์ ๊ธฐ๋ฅ์ ํตํ ์ฌ์ฉ์ ๊ฐ ์ธํฐ๋์
- ์ธ๊ธฐ ๋ฐ์ดํฐ๋ฅผ ์ค์๊ฐ์ผ๋ก ๋ฐ์ํ์ฌ ์ฌ์ฉ์์๊ฒ ๋
ธ์ถ
---
## โจ ์ฃผ์ ๊ธฐ๋ฅ ์๊ฐ
1. **ํธ๋ํน ๊ธฐ๋ฅ:**
- ์ฌ์ฉ์์ ์ด๋ ๊ฒฝ๋ก๋ฅผ ์ด๋ฏธ์ง์ ํํ๋ก ์ ์ฅํ์ฌ ์ฐฝ์์ ์ธ ์ฝํ
์ธ ์ ์ ๊ฐ๋ฅ.
- ํธ๋ํน ์ด๋ฏธ์ง๋ฅผ ๊ณต์ ํ์ฌ ํผ๋์ฒ๋ผ ๋
ธ์ถ ๊ฐ๋ฅ.
2. **SNS ํ์ด์ง:**
- ์ฌ์ฉ์๊ฐ ๊ณต์ ํ ํธ๋ํน ์ด๋ฏธ์ง๋ฅผ ์กฐํํ๊ณ ์ข์์๋ฅผ ํตํด ๋ฐ์ํ ์ ์๋ SNSํ ํผ๋ ์ ๊ณต.
- ์ธ๊ธฐ ๋ฐ์ดํฐ๋ฅผ ์ค์๊ฐ์ผ๋ก ๋ฐ์ํ์ฌ ๋
ธ์ถ.
3. **๊ทธ๋ฆผ ๊พธ๋ฏธ๊ธฐ ๊ธฐ๋ฅ:**
- ์ฌ์ฉ์๊ฐ ํธ๋ํนํ ๊ฒฝ๋ก๋ฅผ ์์, ๊ตต๊ธฐ ๋ฑ์ ์ต์
์ผ๋ก ๊พธ๋ฐ ์ ์์.
---
## ๐ ๏ธ ๊ธฐ์ ์คํ
- **๋ฐฑ์๋:** Express.js (Node.js ๊ธฐ๋ฐ ํ๋ ์์ํฌ)
- **๋ฐ์ดํฐ๋ฒ ์ด์ค:** PostgreSQL + PostGIS (๊ณต๊ฐ ๋ฐ์ดํฐ ์ฒ๋ฆฌ ์ง์)
- **๋ฐฐํฌ ํ๊ฒฝ:** PM2
- **์ธ์ฆ ๋ฐฉ์:** OAuth 2.0 (๋ค์ด๋ฒ, ์นด์นด์ค, ๊ตฌ๊ธ)
- **์คํ ๋ฆฌ์ง:** AWS S3 (์ด๋ฏธ์ง ์ ์ฅ)
---
## ๐ ํ๋ก์ ํธ ๊ตฌ์กฐ
```bash
DMap-backend/
โโโ src/
โ โโโ constant/ # ์์ ๋ฐ ์ ๊ท ํํ์ ๊ด๋ จ ํ์ผ
โ โโโ database/ # ๋ฐ์ดํฐ๋ฒ ์ด์ค ์ฐ๊ฒฐ ์ค์
โ โโโ middleware/ # ๋ฏธ๋ค์จ์ด ํจ์
โ โโโ module/ # ๊ณตํต ๋ชจ๋
โ โโโ router/ # API ๋ผ์ฐํธ ์ ์
โ โ โโโ account/ # ๊ณ์ ๊ด๋ จ ๊ธฐ๋ฅ
โ โ โ โโโ router.js # ๊ณ์ API ๋ผ์ฐํธ
โ โ โ โโโ service.js # ๊ณ์ ์๋น์ค ๋ก์ง
โ โ โ โโโ sql.js # ๊ณ์ SQL ์ฟผ๋ฆฌ ์ ์
โ โ โโโ tracking/ # ํธ๋ํน ๊ด๋ จ ๊ธฐ๋ฅ
โ โ โโโ sns/ # SNS ๊ด๋ จ ๊ธฐ๋ฅ
โ โ โโโ search/ # ๊ฒ์ ๊ด๋ จ ๊ธฐ๋ฅ
โ โโโ util/ # ์ ํธ๋ฆฌํฐ ํจ์
โโโ .gitignore # Git ๋ฌด์ํ ํ์ผ ๋ชฉ๋ก
โโโ package.json # ํ๋ก์ ํธ ์ข
์์ฑ ๋ฐ ์คํฌ๋ฆฝํธ ์ ์
โโโ package-lock.json # ์ข
์์ฑ ๋ฒ์ ์ ๊ธ
โโโ README.md # ํ๋ก์ ํธ ์ค๋ช
๋ฌธ์
โโโ index.js # ์๋ฒ ์ํธ๋ฆฌ ํฌ์ธํธ
```
---
## ๐ API ๊ฐ์
### **1. ํธ๋ํน API**
| ๋ฉ์๋ | ์๋ํฌ์ธํธ | ์ค๋ช
|
| --- | --- | --- |
| POST | `/tracking` | ํธ๋ํน ์ด๋ฏธ์ง ์์ฑ |
| GET | `/tracking/account/:user_idx/?page=1&category=1` | ๋/๋ค๋ฅธ ์ฌ์ฉ์ ํธ๋ํน ์ด๋ฏธ์ง ๊ฐ์ ธ์ค๊ธฐ |
| DELETE | `/tracking` | ๋์ ํธ๋ํน ์ด๋ฏธ์ง ์ญ์ |
| GET | `/tracking/:tracking_idx` | ํธ๋ํน ๋ผ์ธ ๊ฐ์ ธ์ค๊ธฐ |
| PUT | `/tracking/:tracking_idx` | ํธ๋ํน ์ด๋ฏธ์ง ์์ |
| PUT | `/tracking/toSharing` | ํธ๋ํน ์ด๋ฏธ์ง ๊ณต์ ์ํ ๋ณ๊ฒฝ |
| PUT | `/tracking/toNotShaing` | ํธ๋ํน ์ด๋ฏธ์ง ๋น๊ณต์ ์ํ ๋ณ๊ฒฝ |
---
### **2. SNS API**
| ๋ฉ์๋ | ์๋ํฌ์ธํธ | ์ค๋ช
|
| --- | --- | --- |
| GET | `/sns/?category=default&page=1` | SNS ํ์ด์ง ๊ธฐ๋ณธ ํธ๋ํน ์ด๋ฏธ์ง ๊ฐ์ ธ์ค๊ธฐ |
| GET | `/sns/tracking-image/:tracking_idx` | ํน์ ํธ๋ํน ์ด๋ฏธ์ง ๊ฐ์ ธ์ค๊ธฐ |
| POST | `/sns/like` | ํธ๋ํน ์ด๋ฏธ์ง ์ข์์ |
| DELETE | `/sns/like` | ํธ๋ํน ์ด๋ฏธ์ง ์ข์์ ์ญ์ |
---
### **3. ๊ณ์ (Account) API**
| ๋ฉ์๋ | ์๋ํฌ์ธํธ | ์ค๋ช
|
| --- | --- | --- |
| GET | `/account/login/naver` | ๋ค์ด๋ฒ ๋ก๊ทธ์ธ |
| GET | `/account/login/kakao` | ์นด์นด์ค ๋ก๊ทธ์ธ |
| GET | `/account/login/google` | ๊ตฌ๊ธ ๋ก๊ทธ์ธ |
| GET | `/account/accesstoken` | Access Token ์ฌ๋ฐ๊ธ |
| DELETE | `/account/user` | ํ์ ํํดํ๊ธฐ |
| GET | `/account/me` | ๋ด ์ ๋ณด ๊ฐ์ ธ์ค๊ธฐ |
| GET | `/account/info/:idx` | ํ์ ์ ๋ณด ๊ฐ์ ธ์ค๊ธฐ |
| GET | `/account/nickname` | ๋๋ค์ ๋๋ค ๊ฐ ์ ๊ณต |
| PUT | `/account/nickname` | ๋๋ค์ ์์ ํ๊ธฐ |
| PUT | `/account/image` | ํ๋กํ ์ด๋ฏธ์ง ์์ ํ๊ธฐ |
| DELETE | `/account/image` | ํ๋กํ ์ด๋ฏธ์ง ์ญ์ ํ๊ธฐ |
---
### **4. ๊ฒ์(Search) API**
| ๋ฉ์๋ | ์๋ํฌ์ธํธ | ์ค๋ช
|
| --- | --- | --- |
| GET | `/search/nickname/:text/:page` | ๋๋ค์ ๊ฒ์ |
| GET | `/search/searchpoint/:text/:page` | ํธ๋ํน ์ด๋ฏธ์ง ๊ฒ์ |
---
## ๐ ํ๋ก์ ํธ ๋ฌธ์
- [์๊ตฌ์ฌํญ ๋ช
์ธ์](#)
- [์์ด์ดํ๋ ์](#)
- [ํ์ด์ง ๋ช
์ธ์](#)
- [DB ํ
์ด๋ธ ๋ช
์ธ์](#)
- [API ๋ช
์ธ์](#)
- [ํ์
๋
ธ์
ํ์ด์ง](#)
(๋ฌธ์ ๋งํฌ๋ ์ถํ ์
๋ฐ์ดํธ ์์ )
---