Merge pull request #136 from boostcampwm-2024/feature/be/#80-getLocation

[Feat][BE] : #40 : webSocket 연결 세팅

.github/workflows/auto-merge.yml

@@ -14,20 +14,20 @@ jobs:
         with:
           result-encoding: string
           script: |
-            const { data: pr } = await github.pulls.get({
+            const { data: pr } = await github.rest.pulls.get({
               owner: context.repo.owner,
               repo: context.repo.repo,
               pull_number: context.payload.pull_request.number,
             });
-            return JSON.stringify(pr);
+            core.setOutput('prResult', JSON.stringify(pr));
 
       - name: 'Check Approvals and Labels'
         id: check
         uses: actions/github-script@v6
         with:
           script: |
-            const pr = JSON.parse(steps.pr.outputs.result);
-            const reviews = await github.pulls.listReviews({
+            const pr = JSON.parse(process.env.PR_RESULT);
+            const reviews = await github.rest.pulls.listReviews({
               owner: context.repo.owner,
               repo: context.repo.repo,
               pull_number: pr.number,
@@ -37,7 +37,9 @@ jobs:
 
             // 메인 브랜치로 향하는 PR인 경우 리뷰어 3명, 다른 브랜치인 경우 2명 필요
             const requiredApprovals = pr.base.ref === 'main' ? 3 : 2;
-            return approvals.length >= requiredApprovals && hasLabel;
+
+            // Check 조건 결과를 출력에 설정
+            core.setOutput('result', approvals.length >= requiredApprovals && hasLabel);
 
       - name: 'Change Label to 작업 완료'
         if: steps.check.outputs.result == 'true'
@@ -58,10 +60,10 @@ jobs:
         uses: actions/github-script@v6
         with:
           script: |
-            await github.pulls.merge({
+            await github.rest.pulls.merge({
               owner: context.repo.owner,
               repo: context.repo.repo,
               pull_number: context.payload.pull_request.number,
-              merge_method: 'merge', # 'squash' 또는 'rebase'로도 설정 가능
+              merge_method: 'merge', // 'squash' 또는 'rebase'로도 설정 가능
               commit_title: `자동 머지: PR #${context.payload.pull_request.number}`
             });

.gitignore

@@ -5,9 +5,6 @@
 #TMP
 tmp
 
-#DOCS
-/docs
-
 #idea
 .idea
 

backend/package.json

@@ -24,6 +24,7 @@
     "express": "^4.21.1",
     "pg": "^8.13.1",
     "swagger-jsdoc": "^6.2.8",
-    "swagger-ui-express": "^5.0.1"
+    "swagger-ui-express": "^5.0.1",
+    "ws": "^8.18.0"
   }
 }

backend/src/constants.js

@@ -0,0 +1 @@
+export const PORT = 3001;

backend/src/index.js

@@ -1,11 +1,13 @@
 import express from 'express';
 import swaggerUi from 'swagger-ui-express';
+import http from 'http';
 import { specs } from '../swaggerConfig';
 import { pool } from './db';
+import { PORT } from './constants';
+import { initializeWebSocketServer } from './websocketServer';
 
 const app = express();
 app.use(express.json());
-const port = 3001;
 
 app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(specs));
 
@@ -25,6 +27,12 @@ app.get('/example', (req, res) => {
   res.send('Hello World');
 });
 
-app.listen(port, () => {
-  console.log(`Server is running on http://localhost:${port}`);
+// HTTP 서버 생성
+const server = http.createServer(app);
+
+// WebSocket 서버 초기화
+initializeWebSocketServer(server);
+
+app.listen(PORT, () => {
+  console.log(`Server is running on http://localhost:${PORT}`);
 });

backend/src/websocketServer.js

@@ -0,0 +1,41 @@
+import { WebSocketServer } from 'ws';
+
+const activeConnections = {}; // token별로 연결을 관리하기 위한 객체
+
+export function initializeWebSocketServer(server) {
+  const wss = new WebSocketServer({ server });
+
+  wss.on('connection', (ws, req) => {
+    // URL에서 token 추출
+    // TODO: 프론트 라우터 및 token 설정 완료 후 테스트
+    const url = new URL(req.url, `http://${req.headers.host}`);
+    const token = url.searchParams.get('token');
+
+    if (!token) {
+      ws.close(4001, 'Token is required');
+      return;
+    }
+
+    // 동일한 token으로 이미 연결된 클라이언트가 있으면 이전 연결을 강제로 종료
+    if (activeConnections[token]) {
+      activeConnections[token].close(4000, 'Duplicate connection');
+    }
+
+    // 새로운 연결을 활성화된 연결 목록에 저장
+    activeConnections[token] = ws;
+
+    console.log(`Client connected with token: ${token}`);
+
+    // 클라이언트로부터 메시지 받았을 때의 이벤트 처리
+    ws.on('message', message => {
+      console.log(`Received from ${token}:`, message);
+    });
+
+    // 클라이언트 연결 종료 시
+    ws.on('close', (code, reason) => {
+      console.log(`Client disconnected with token: ${token}, Code: ${code}, Reason: ${reason}`);
+      // 연결이 종료되면 activeConnections에서 해당 token 제거
+      delete activeConnections[token];
+    });
+  });
+}

docs/docusaurus/.gitignore

@@ -0,0 +1,27 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+.docusaurus
+build

docs/docusaurus/README.md

@@ -0,0 +1,60 @@
+<div align="center">
+    <img width="600" alt="image" src="https://github.com/user-attachments/assets/f7973fe3-dd8a-4643-9536-53e63db1f6fe">
+   <h3 align="center">🧭 선따라 길따라 🧭</h3>
+    <h4 align="center">중장년층을 위한 접근성을 바탕으로 한 위치 기반 서비스</h4>
+</div>
+
+
+<div align="center">
+<br />
+
+## 👩‍💻 팀 소개
+
+<img width="200" src="https://github.com/user-attachments/assets/ab367ecb-be89-4076-abdf-bf00bdc29a4f" />
+<div>(따라핑)</div>
+
+### 안녕하세요, 팀 "따라따라" 입니다!
+
+<br />
+
+## 🗝 링크 안내
+
+<p>  
+  <a href="https://www.notion.so/127b1b2b649180e88f70d6a4648924a0?pvs=4">팀 노션</a>   |   
+  <a href="https://github.com/boostcampwm-2024/web28-DDara/wiki">팀 위키</a> |
+  <a href="https://www.figma.com/design/r9nl4Jcz9VXIMbrpf50wY6/PickMeUp?node-id=90-1897">기획서</a>   |   
+  <a href="https://www.figma.com/design/r9nl4Jcz9VXIMbrpf50wY6/PickMeUp?node-id=87-929">디자인</a>
+<!--   <br />
+  <a href="https://www.notion.so/127b1b2b6491805b9055d480ab56e432?v=ee8c766f016148d7bfd6c6f49d782b10&pvs=4">회의록</a>   |  
+  <a href="https://www.notion.so/129b1b2b649180ef8ad6f356251f2dec?pvs=4">그라운드 룰</a>   |   
+  <a href="https://www.notion.so/812667c55af84dba8d18f4902b56a85e?pvs=4">기능 명세</a> -->
+</p>
+
+</div>
+
+<div align="center">
+<br /><br /><br />
+
+
+
+## 🌱 팀원 소개
+
+|J060_김주원|J174_이동율|J210_임재도|J234_정혜인|
+|:--:|:--:|:--:|:--:|
+|<a href="https://github.com/juwon5272"><img src="https://github.com/user-attachments/assets/f774ff48-8831-490f-b0fe-b18b024f7916" width="150px;" alt=""/></a>|<a href="https://github.com/leedongyull"><img src="https://github.com/user-attachments/assets/4d682b1f-0f91-4547-8a7d-1f6b00bee674" width="150px;" alt=""/></a>|<a href="https://github.com/effozen"><img src="https://github.com/user-attachments/assets/92bddae1-19ce-4b06-811e-52df15ac726c" width="150px;" alt=""/></a>|<a href="https://github.com/happyhyep"><img src="https://github.com/user-attachments/assets/40ac933c-3e19-4884-a5e9-da2f2298dd72" width="150px;" alt=""/></a>|
+|FE|FE|FE|Full Stack (FE + BE)|
+|<a href="https://github.com/juwon5272">@juwon5272</a>|<a href="https://github.com/leedongyull">@leedongyull</a>|<a href="https://github.com/effozen">@effozen</a>|<a href="https://github.com/happyhyep">@happyhyep</a>|
+
+<br />
+
+## ⛏ 기술 스택
+
+추후 추가 예정입니다.
+
+<!--
+## 👨‍👨‍👧‍👦 협업 전략
+
+## 👂 그라운드 룰
+
+-->
+</div>

docs/docusaurus/dev_log/authors.yml

@@ -0,0 +1,33 @@
+zen:
+  name: 임재도
+  title: J210
+  url: https://fantasmith.com
+  image_url: https://github.com/effozen.png
+  socials:
+    x: EffoZen
+    github: effozen
+    linkedin: effozen
+
+leedongyull:
+  name: 이동율
+  title: J174
+  url: https://github.com/leedongyull
+  image_url: https://github.com/leedongyull.png
+  socials:
+    github: leedongyull
+
+juwon5272:
+  name: 김주원
+  title: J060
+  url: https://github.com/juwon5272
+  image_url: https://github.com/juwon5272.png
+  socials:
+    github: juwon5272
+
+happyhyep:
+  name: 정혜인
+  title: J234
+  url: https://github.com/happyhyep
+  image_url: https://github.com/happyhyep.png
+  socials:
+    github: happyhyep

docs/docusaurus/dev_log/intro.mdx

@@ -0,0 +1,127 @@
+---
+slug: ground_rule
+title: ⚖️ Ground Rule
+tags: [teamInfo]
+sidebar_position: 2
+sidebar_label: ⚖️ 그라운드 룰
+keywords: ['members', 'team', '팀원', '소개']
+pagination_label: Markdown features
+authors: [zen]
+last_update:
+  date: 2024-10-30
+  authors: [zen]
+---
+
+<br/>
+
+> 우리들의 공통 목표와 그에 따른 행동 강령입니다.
+팀의 모든 의사결정은 그라운드 룰에 입각해서 판단합니다.
+>
+
+
+## ❓ 제 1 원칙
+
+### ❓ No Dummy Qeustion!
+
+- 세상에 바보같은 질문은 없습니다. 그 태도에 문제가 있을 뿐.
+- 저희는 절대 그 어떠한 질문에도 비웃음, 조소 등을 표하지 않습니다..!
+- 어떠한 질문에도 최선의 답을 제공합니다.
+- 반대로, 질문자는 반드시 질문하는 것에 대한 근거를 마련한 상태로 질문합니다.
+- 상호 예의를 존중합니다.
+
+<br/><br/>
+
+## 📝 프로젝트에 대한 공통의 목표
+
+### 🚀 포트폴리오에 쓸 수 있는 실사용자를 위한 서비스
+
+- **포트폴리오에 담을 가치 있는 프로젝트를 개발**: 모든 팀원은 포트폴리오로 활용할 수 있는 완성도 높은 프로젝트를 목표로 한다.
+- **실사용자에게 의미 있는 서비스**: 프로젝트는 실제 사용자에게 도움이 될 수 있는 기능을 제공해야 한다. 재미를 위한 프로젝트일지라도, 명확한 사용자 경험(UX)을 기반으로 해야 함.
+- **유지보수 가능성**: 프로젝트는 지속적으로 유지보수될 수 있도록 설계하며, 최소 1년간 유지보수할 수 있도록 계획을 세운다.
+
+<br/><br/>
+
+
+## 📝 기술적인 목표
+
+- 추후 주제가 정해지면 도입
+
+<br/><br/>
+
+## 📝 팀 문화
+
+### 😆 싱글벙글 하하호호 우리들
+
+- **즐겁고 활발한 팀 분위기**: 팀원들 간에 **소통이 원활하고 편안한 분위기**를 유지한다. 스몰톡이나 비공식적인 대화를 통해 팀 분위기를 활기차게 유지하며, 서로의 동기부여를 위해 노력한다.
+- **건강과 워라밸 존중**: 과도한 업무보다는 건강을 최우선으로 고려하며, **휴식이 필요한 경우** 언제든 자유롭게 쉬는 문화를 장려한다. 장기적으로 **지속 가능한 프로젝트**를 목표로 한다. 단, 마감 직전이나 스프린트 때는 달린다.
+- **각자의 의견 존중**: 서로의 의견을 경청하고, 의견 충돌이 발생했을 때는 둘 사이에서 해결보다는 반드시 팀원 전체가 참여하여 논의한다. 이때, 다수결 또는 협의를 통해 해결한다. 필요한 경우 **카드를 사용한 의사결정 방식**(ex: "나 말 좀 하게 해줘 카드")을 도입해 원활한 의사결정을 진행할 수 있도록 한다.
+
+<br/><br/>
+
+## 📝 협업 및 의사소통 규칙
+
+### 💬 잦은 커뮤니케이션을 할 수 있어야 한다.
+
+- **슬랙 및 협업 도구 활용**: 슬랙을 기본 소통 도구로 사용하며, 메시지를 읽었을 때는 **이모지 대신 명확한 답변**을 남겨 소통의 명확성을 유지한다.
+- **실시간 협업 도구 사용**: 실시간 소통이 필요한 경우, `Zep` 을 사용해 비대면 상황에서도 **실시간 피드백과 소통**이 이루어지도록 한다.
+- **코어 타임 준수**: 매일 10시부터 7시까지 코어 타임을 운영하며, 이 시간 동안에는 집중적으로 프로젝트에 참여하고 빠른 피드백을 제공한다. 코어 타임 외에는 자율적으로 활동할 수 있지만, 긴급한 상황에서는 `Zep`, `슬랙`을 통해 즉각적인 소통이 이루어져야 한다.
+- **신뢰**: 주변의 반응 및 생각에 흔들리지 말고, 팀이 결정한 내용을 전적으로 신뢰한다.
+
+
+<br/><br/>
+
+## 📝 의사결정 방식
+
+### 🤝 팀 전체가 동의하는 의사결정
+
+- **의사결정은 팀 전체가 참여**: 주요 결정은 팀원 모두가 논의하며, GitHub Issue를 통해 정리된 문제점과 해결 방안을 공유한 후, 충분한 근거를 바탕으로 결정한다.
+- **데일리 스크럼**: 매일 아침 **데일리 스크럼**을 통해 각자의 작업 진행 상황을 공유하고, 문제점 및 해결책을 논의한다.
+- **긴급 의사결정**: 필요시 `Zep` 또는 `슬랙` 언급을 통해 팀원들을 소집해 **긴급 의사결정**을 빠르게 내린다.
+- **내 말좀 들어줘 카드!:** 각자 2 장의 카드가 부여되며, 서로가 납득할만한 수준에서 의견이 대립될 때 사용한다. 사용한 사람의 의견을 무조건적으로 수용한다. (”서로가 납득 가능한 상식선”이라는 전제)
+
+<br/><br/>
+
+## 📝 프로젝트 개발 원칙
+
+### 😇 사용자 경험(UX) 중심의 개발
+
+- **사용자 경험(UX) 중심 개발**: 기술적인 완성도뿐만 아니라 **사용자의 관점에서 서비스의 유용성**을 고려한다. 기능이 잘 동작할 뿐 아니라, 사용자가 쉽게 이해하고 사용할 수 있어야 한다.
+- **작업 공유 및 문서화**: 모든 작업은 명확히 공유되어야 하며, **GitHub Issue**와 **노션**을 통해 진행 상황과 문제점을 기록한다. 트러블슈팅, 배운 기술, 이슈 등을 꼼꼼히 문서화해 프로젝트의 전체 진행을 기록한다.
+
+<br/><br/>
+
+## 📝 작업 분배 및 기록 관리
+
+### 🧑‍🤝‍🧑 분업이 아닌 협업
+
+- **작업 기록 관리**: 모든 작업은 노션과 GitHub Pull Request, Issue 등을 통해 **투명하게 관리**된다. 이를 통해 프로젝트의 진행 상황을 쉽게 파악하고, 작업의 흐름을 유지할 수 있다.
+- **스프린트 방식 도입**: 코어 타임 내에서 주어진 작업을 마무리하고, **주 단위로 목표를 설정해 달성 여부를 확인**한다. 스프린트 종료 후 회고를 진행해 다음 스프린트에 반영할 개선점을 도출한다.
+
+<br/><br/>
+
+## 📝 코드 리뷰 및 PR 규칙
+
+### 🧑‍💻 4명의 PR Approve 및 최소 주 2회의 코드 리뷰
+
+- **최소 주 2회의 컨벤션 및 맥락 파악 목적의 코드 리뷰**: 팀원들이 서로의 코드를 리뷰하며, 코드의 품질도 중요하지만, 이때의 핵심은 우리의 컨벤션을 서로 얼마나 잘 지키고 있는지 이다.. 코드 리뷰는 팀원의 성장뿐 아니라, **서로의 작업을 이해하고 소통하는 과정**으로 삼는다. 즉, 각자의 개발 맥락을 파악하는 목적을 주로 한다.
+- **PR 승인 규칙**: 4명 모두의 **PR 승인**이 있어야만 기능을 머지할 수 있으며, 모든 팀원이 해당 기능에 대한 충분한 이해를 갖출 수 있도록 한다.
+- **작업의 투명성 유지**: 코드 리뷰와 PR을 통해 프로젝트의 모든 진행이 투명하게 공유되며, 이는 팀원 간의 신뢰를 강화하는 중요한 요소로 작용한다.
+- **데일리 스크럼의 활용:** 이슈나, 코드 공유 등은 데일리 스크럼 시간에 더하여, 아침에 소통하도록 한다.
+
+<br/><br/>
+
+## 📝 프로젝트 회고
+
+### 🎨 Figma, Miro 등을 이용한 시각적인 회고
+
+- **회고 방식**: 프로젝트 진행 중 **KPT(Keep, Problem, Try) 방식**으로 주기적인 회고를 진행해, 잘한 부분과 개선할 점을 분석하고 다음 스프린트에 반영한다. 피드백은 GitHub 또는 피그마 등을 활용해 시각적으로 정리한다.
+- **결과 기록**: 회고 내용과 함께 프로젝트 과정에서의 문제점과 해결 방안을 기록하여 **포트폴리오에서 활용**할 수 있는 자료로 남긴다.
+
+<br/><br/>
+
+## 📝 긴급 상황 대응
+
+### 👀  ”이의있소!”
+
+- **TMT, TMI 방지 카드**: 각 팀원은 필요시 언제든지 **"나 힘들다 카드"**를 사용해 TMT, TMI를 막을 수 있다. 이때, 😪, 😴 와 같은 이모지나 기능을 사용해서 알린다.
+- **스톱 카드**: 기술에 대한 학습이나, 구현이 요구사항을 넘어서 너무 깊어질 경우 **"스톱 카드"**를 사용해 중단시키고, 본래 해야하는 업무에 집중시킨다. 이는 PR 리뷰를 하면서든, 언제든지 자유롭게 제안할 수 있다.