Merge pull request #176 from boostcampwm2023/dev

Release: v0.1 릴리즈

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,59 @@
+---
+name: Bug report
+about: 버그 관련 리포트 이슈 작성을 위한 템플릿입니다.
+title: 'Fix: OO 오류'
+labels: "\U0001F41E Fix"
+assignees: ''
+
+---
+
+<!-- 🔥 다음 양식으로 제목을 작성해주세요 : Fix: OO 오류 -->
+<!-- "여기에 작성하세요" 는 지우고 작성하세요 🙏🏻 -->
+
+## 버그 설명
+<!-- 어떤 버그인지 자세히 알려주세요 -->
+여기에 작성하세요
+
+## 재현 방법
+<!-- 다음과 같이 단계별로 작성해주세요 :
+e.g.
+1. 해당 페이지에서 작업 중
+2. 이것을 클릭했는데
+3. 그리고 여기서 스크롤을 내렸더니
+4. "..." 한 오류를 발견했다.
+ -->
+1. 여기에 작성하세요
+2. 여기에 작성하세요
+3. 여기에 작성하세요
+4. 여기에 작성하세요
+
+## 예상한 결과
+<!-- 예상했던 결과는 어떤 것이었는지 알려주세요 -->
+여기에 작성하세요
+
+## 스크린샷
+<!-- 문제를 파악하는 데 도움이 되는 스크린샷을 추가해주세요 -->
+여기에 작성하세요
+
+## 디바이스 환경
+<!-- 작업을 진행하는 디바이스 환경을 다음과 같이 작성해주세요 :
+Desktop
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+Smartphone
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+ -->
+Type
+- Device: 여기에 작성하세요 (Smartphone 일 경우)
+- OS: 여기에 작성하세요
+- Browser: 여기에 작성하세요
+- Version: 여기에 작성하세요
+
+## 추가 내용
+<!-- 문제를 해결하기 위한 추가적인 정보를 알려주세요 -->
+여기에 작성하세요

.github/ISSUE_TEMPLATE/feature-issue.md

@@ -0,0 +1,25 @@
+---
+name: Feature Issue
+about: 기능 관련 이슈 작성을 위한 템플릿입니다.
+title: 'Feature: OO 구현'
+labels: "✨ Feat"
+assignees: ''
+
+---
+
+<!-- 🔥 다음 양식으로 제목을 작성해주세요 : Feature: OO 구현 -->
+<!-- "여기에 작성하세요" 는 지우고 작성하세요 🙏🏻 -->
+
+## Feature Description
+<!-- 새로운 기능에 관해서 간결하게 적어주세요 -->
+여기에 작성하세요
+
+## To-Do
+<!-- 새로운 기능과 관련해서 한 일에 대해 적어주세요 -->
+- [ ] Todo1
+- [ ] Todo2
+- [ ] Todo3
+
+### 추가 사항
+<!-- 새로운 기능에 대한 추가적인 정보를 알려주세요 -->
+여기에 작성하세요

.github/ISSUE_TEMPLATE/refactoring-issue.md

@@ -0,0 +1,59 @@
+---
+name: Refactoring Issue
+about: 리펙토링 관련 이슈 작성을 위한 템플릿입니다.
+title: 'Refactor: OO 개선'
+labels: "\U0001F6E0️ Refactor"
+assignees: ''
+
+---
+
+<!-- 🔥 다음 양식으로 제목을 작성해주세요 : Refactor: OO 개선 -->
+<!-- "여기에 작성하세요" 는 지우고 작성하세요 🙏🏻 -->
+
+## 기존 문제점 설명
+<!-- 어떤 문제가 있었는지 자세히 알려주세요 -->
+여기에 작성하세요
+
+## 재현 방법
+<!-- 다음과 같이 단계별로 작성해주세요 :
+e.g.
+1. 해당 페이지에서 작업 중
+2. 이것을 클릭했는데
+3. 그리고 여기서 스크롤을 내렸더니
+4. "..." 한 오류를 발견했다.
+ -->
+1. 여기에 작성하세요
+2. 여기에 작성하세요
+3. 여기에 작성하세요
+4. 여기에 작성하세요
+
+## 예상한 결과
+<!-- 예상했던 결과는 어떤 것이었는지 알려주세요 -->
+여기에 작성하세요
+
+## 스크린샷
+<!-- 문제를 파악하는 데 도움이 되는 스크린샷을 추가해주세요 -->
+여기에 작성하세요
+
+## 디바이스 환경
+<!-- 작업을 진행하는 디바이스 환경을 다음과 같이 작성해주세요 :
+Desktop
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+Smartphone
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+ -->
+Type
+- Device: 여기에 작성하세요 (Smartphone 일 경우)
+- OS: 여기에 작성하세요
+- Browser: 여기에 작성하세요
+- Version: 여기에 작성하세요
+
+## 추가 내용
+<!-- 문제를 해결하기 위한 추가적인 정보를 알려주세요 -->
+여기에 작성하세요

.github/pull_request_template.md

@@ -0,0 +1,19 @@
+<!-- 🔥 다음 양식으로 제목을 작성해주세요 : 한 일의 type(#issue number): 작업 내용 -->
+<!-- ex) Feature(#133): canvas 구현~ -->
+<!-- "여기에 작성하세요" 는 지우고 작성하세요 🙏🏻 -->
+
+## 작업 개요
+<!-- 작업에 대한 설명을 간단하게 작성해주세요. -->
+여기에 작성하세요
+
+## 작업 사항
+<!-- 작업에 대한 설명을 코드와 관련하여 남겨주세요. -->
+여기에 작성하세요
+
+## 고민한 점들(필수 X)
+<!-- 작업을 진행하면서 고민했던 점들을 추가해주세요 -->
+여기에 작성하세요
+
+## 스크린샷(필수 X)
+<!-- 작업을 파악하는 데 도움이 되는 스크린샷을 추가해주세요 -->
+여기에 작성하세요

.github/workflows/github_actions_cd.yml

@@ -0,0 +1,18 @@
+name: github_actions_cd
+
+on:
+  push:
+    branches: ["main"]
+    paths-ignore:
+      - 'frontend/**'
+
+jobs:
+  build:
+    runs-on: self-hosted
+    steps:
+      - name: pull Docker image
+        run: sudo docker pull ${{secrets.DOCKERHUB_USERNAME}}/boarlog-backend:latest
+      - name: delete old docker container
+        run: sudo docker rm -f boarlog-backend-container || true
+      - name: run docker container
+        run: sudo docker run -d -p 8000:3000 --name boarlog-backend-container ${{secrets.DOCKERHUB_USERNAME}}/boarlog-backend

.github/workflows/github_actions_ci.yml

@@ -0,0 +1,24 @@
+name: github_actions_ci
+
+on:
+  push:
+    branches: ["dev"]
+    paths-ignore:
+      - 'frontend/**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Dockerhub Login
+        env:
+          DOCKER_USERNAME: ${{secrets.DOCKERHUB_USERNAME}}
+          DOCKER_PASSWORD: ${{secrets.DOCKERHUB_TOKEN}}
+        run: docker login -u $DOCKER_USERNAME -p $DOCKER_PASSWORD
+      - name: Build Docker image
+        run: docker build -t boarlog-backend ./backend
+      - name: taging
+        run: docker tag boarlog-backend:latest ${{secrets.DOCKERHUB_USERNAME}}/boarlog-backend:latest
+      - name: push to Dockerhub
+        run: docker push ${{secrets.DOCKERHUB_USERNAME}}/boarlog-backend:latest

.gitignore

@@ -0,0 +1,37 @@
+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+.env

README.md

@@ -1 +1,102 @@
-# web13_528nm
+
+<img src="https://github.com/boostcampwm2023/web13_Boarlog/assets/54176384/2e33bb1f-cdcd-42df-bbc0-c9a52ab54b61" alt="boarlog logo" width='200px'/>
+
+<br/>
+<br/>
+
+
+## 프로젝트 소개: 기록으로 남기는 실시간 강의, Boarlog
+
+> **필기앱처럼 강의도 기록으로 남기면 어떨까?**
+
+**Boarlog**는 교육 및 협업을 위한 실시간 화이트보드 강의 플랫폼입니다. 음성 기반 강의와 시각적 상호작용을 결합하여 참여자들에게 효과적이고 몰입도 높은 학습 경험을 제공합니다.
+
+- **강의 생성 및 진행**: 강의자는 손쉽게 강의방을 열고, 음성으로 강의하며 화이트보드를 실시간으로 편집할 수 있습니다.
+- **강의 참여**: 참여자들은 강의에 접속하여 강의자의 음성과 화이트보드 내용을 실시간으로 볼 수 있습니다.
+- **상호작용 및 피드백**: 참여자들은 질문을 보내고, 강의자는 이를 포스트잇 형태로 화이트보드에 추가하여 답변할 수 있습니다.
+- **강의 기록 및 재생**: 강의 종료 후에는 AI를 활용하여 음성을 스크립트로 변환, 이를 화이트보드 내용과 함께 저장하여 언제든지 다시볼 수 있습니다.
+
+<br/>
+
+## 임시 배포 링크
+
+- 화이트보드
+    - https://boarlog.netlify.app/test
+- 마이크
+    - https://boarlog.netlify.app/mictest
+- UI
+    - https://boarlog.netlify.app/example
+
+## 팀 소개: TEAM_528
+
+```jsx
+const teamName = camperIdArray.reduce((team, camperId) => {
+	return team += parseInt(camperId.replace(/[^0-9]/g, ""));
+}, 0)
+
+// 팀에 우리를 더하다.
+```
+
+> **5명이 모여 하나의 개발자처럼.**
+
+`528`은 팀원 5명의 캠퍼 번호를 더한 숫자입니다(63+95+105+124+141). 
+
+5명의 캠퍼가 하나의 번호를 가지고 서로 다른 기술, 경험, 및 아이디어를 결합하여 시너지를 발휘하고자 합니다.
+
+<table align=center>
+    <thead>
+        <tr>
+            <th>변진상 (FE)</th>
+            <th>이동령 (FE)</th>
+            <th>이승연 (BE)</th>
+            <th>이현종 (BE)</th>
+            <th>정주완 (FE)</th>
+        </tr>
+    </thead>
+    <tbody align=center>
+        <tr>
+            <td>
+              <a href="https://github.com/Byeonjin"><img width="120" height="120" src="https://avatars.githubusercontent.com/u/54176384?v=4" /></a>
+            </td>
+            <td>
+              <a href="https://github.com/LellowMellow"><img width="120" height="120" src="https://avatars.githubusercontent.com/u/79556112?v=4" /></a>
+            </td>
+            <td>
+              <a href="https://github.com/tmddus2"><img width="120" height="120" src="https://avatars.githubusercontent.com/u/49530253?v=4" /></a>
+            </td>
+            <td>
+              <a href="https://github.com/platinouss"><img width="120" height="120" src="https://avatars.githubusercontent.com/u/70827921?v=4" /></a>
+            </td>
+            <td>
+              <a href="https://github.com/Jw705"><img width="120" height="120" src="https://avatars.githubusercontent.com/u/86391351?v=4" /></a>
+            </td>
+        </tr>
+        <tr>
+            <td><a href="https://github.com/Byeonjin">@Byeonjin</a></td>
+            <td><a href="https://github.com/LellowMellow">@LellowMellow</a></td>
+            <td><a href="https://github.com/tmddus2">@tmddus2</a></td>
+            <td><a href="https://github.com/platinouss">@platinouss</a></td>
+            <td><a href="https://github.com/Jw705">@Jw705</a></td>
+        </tr>
+        <tr align=left>
+            <td width="200">깊이있게 고민하고 기록하기</td>
+            <td width="200">괜한 걱정 하지 않고 차근차근 쌓아올리기</td>
+            <td width="200">두려워하지 않고 문제 해결하기</td>
+            <td width="200">기술 선택에 나만의 근거를 만들기</td>
+            <td width="200">작성한 코드에 대한 의도를 잘 기록하기</td>
+        </tr>
+    </tbody>
+</table>
+
+<br/>
+
+## 바로가기
+
+- [그라운드 룰](https://weak-sugar-603.notion.site/Ground-Rules-43ebfd44b76c482a983c4a47481028ca?pvs=4)
+- [branch/conmmit 컨벤션](https://weak-sugar-603.notion.site/Git-Branch-Commmit-882a35cba1cc433eb0f01abf2e3b134d?pvs=4)
+- [기획/디자인](https://www.figma.com/file/vd1TPvzMNwy6OfVmNFw8cI/Untitled?type=design&node-id=4%3A22&mode=design&t=NS1IQkeFYsr7lSuf-1)
+- [위키](https://github.com/boostcampwm2023/web13_TEAM_528/wiki)
+- [노션](https://weak-sugar-603.notion.site/TEAM_528-7780e03d7e9847b89fdf9f926036987b?pvs=4)
+- [백로그](https://www.notion.so/d1fb2080ff934e859d50c5cd3620e223)
+- [데모 링크](https://boarlog.netlify.app/test)
+

backend/.dockerignore

@@ -0,0 +1,5 @@
+.git
+.env
+Dockerfile
+dist
+node_modules

backend/.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir: __dirname,
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};