Skip to content

Commit 71ad31e

Browse files
ByeonjinByeonjin
authored
Merge pull request #176 from boostcampwm2023/dev
Release: v0.1 릴리즈
2 parents c0fa566 + f025eb6 commit 71ad31e

File tree

197 files changed

+38180
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

197 files changed

+38180
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
name: Bug report
3+
about: 버그 관련 리포트 이슈 작성을 위한 템플릿입니다.
4+
title: 'Fix: OO 오류'
5+
labels: "\U0001F41E Fix"
6+
assignees: ''
7+
8+
---
9+
10+
<!-- 🔥 다음 양식으로 제목을 작성해주세요 : Fix: OO 오류 -->
11+
<!-- "여기에 작성하세요" 는 지우고 작성하세요 🙏🏻 -->
12+
13+
## 버그 설명
14+
<!-- 어떤 버그인지 자세히 알려주세요 -->
15+
여기에 작성하세요
16+
17+
## 재현 방법
18+
<!-- 다음과 같이 단계별로 작성해주세요 :
19+
e.g.
20+
1. 해당 페이지에서 작업 중
21+
2. 이것을 클릭했는데
22+
3. 그리고 여기서 스크롤을 내렸더니
23+
4. "..." 한 오류를 발견했다.
24+
-->
25+
1. 여기에 작성하세요
26+
2. 여기에 작성하세요
27+
3. 여기에 작성하세요
28+
4. 여기에 작성하세요
29+
30+
## 예상한 결과
31+
<!-- 예상했던 결과는 어떤 것이었는지 알려주세요 -->
32+
여기에 작성하세요
33+
34+
## 스크린샷
35+
<!-- 문제를 파악하는 데 도움이 되는 스크린샷을 추가해주세요 -->
36+
여기에 작성하세요
37+
38+
## 디바이스 환경
39+
<!-- 작업을 진행하는 디바이스 환경을 다음과 같이 작성해주세요 :
40+
Desktop
41+
- OS: [e.g. iOS]
42+
- Browser [e.g. chrome, safari]
43+
- Version [e.g. 22]
44+
45+
Smartphone
46+
- Device: [e.g. iPhone6]
47+
- OS: [e.g. iOS8.1]
48+
- Browser [e.g. stock browser, safari]
49+
- Version [e.g. 22]
50+
-->
51+
Type
52+
- Device: 여기에 작성하세요 (Smartphone 일 경우)
53+
- OS: 여기에 작성하세요
54+
- Browser: 여기에 작성하세요
55+
- Version: 여기에 작성하세요
56+
57+
## 추가 내용
58+
<!-- 문제를 해결하기 위한 추가적인 정보를 알려주세요 -->
59+
여기에 작성하세요

‎.github/ISSUE_TEMPLATE/feature-issue.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Feature Issue
3+
about: 기능 관련 이슈 작성을 위한 템플릿입니다.
4+
title: 'Feature: OO 구현'
5+
labels: "✨ Feat"
6+
assignees: ''
7+
8+
---
9+
10+
<!-- 🔥 다음 양식으로 제목을 작성해주세요 : Feature: OO 구현 -->
11+
<!-- "여기에 작성하세요" 는 지우고 작성하세요 🙏🏻 -->
12+
13+
## Feature Description
14+
<!-- 새로운 기능에 관해서 간결하게 적어주세요 -->
15+
여기에 작성하세요
16+
17+
## To-Do
18+
<!-- 새로운 기능과 관련해서 한 일에 대해 적어주세요 -->
19+
- [ ] Todo1
20+
- [ ] Todo2
21+
- [ ] Todo3
22+
23+
### 추가 사항
24+
<!-- 새로운 기능에 대한 추가적인 정보를 알려주세요 -->
25+
여기에 작성하세요

‎.github/ISSUE_TEMPLATE/refactoring-issue.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
name: Refactoring Issue
3+
about: 리펙토링 관련 이슈 작성을 위한 템플릿입니다.
4+
title: 'Refactor: OO 개선'
5+
labels: "\U0001F6E0️ Refactor"
6+
assignees: ''
7+
8+
---
9+
10+
<!-- 🔥 다음 양식으로 제목을 작성해주세요 : Refactor: OO 개선 -->
11+
<!-- "여기에 작성하세요" 는 지우고 작성하세요 🙏🏻 -->
12+
13+
## 기존 문제점 설명
14+
<!-- 어떤 문제가 있었는지 자세히 알려주세요 -->
15+
여기에 작성하세요
16+
17+
## 재현 방법
18+
<!-- 다음과 같이 단계별로 작성해주세요 :
19+
e.g.
20+
1. 해당 페이지에서 작업 중
21+
2. 이것을 클릭했는데
22+
3. 그리고 여기서 스크롤을 내렸더니
23+
4. "..." 한 오류를 발견했다.
24+
-->
25+
1. 여기에 작성하세요
26+
2. 여기에 작성하세요
27+
3. 여기에 작성하세요
28+
4. 여기에 작성하세요
29+
30+
## 예상한 결과
31+
<!-- 예상했던 결과는 어떤 것이었는지 알려주세요 -->
32+
여기에 작성하세요
33+
34+
## 스크린샷
35+
<!-- 문제를 파악하는 데 도움이 되는 스크린샷을 추가해주세요 -->
36+
여기에 작성하세요
37+
38+
## 디바이스 환경
39+
<!-- 작업을 진행하는 디바이스 환경을 다음과 같이 작성해주세요 :
40+
Desktop
41+
- OS: [e.g. iOS]
42+
- Browser [e.g. chrome, safari]
43+
- Version [e.g. 22]
44+
45+
Smartphone
46+
- Device: [e.g. iPhone6]
47+
- OS: [e.g. iOS8.1]
48+
- Browser [e.g. stock browser, safari]
49+
- Version [e.g. 22]
50+
-->
51+
Type
52+
- Device: 여기에 작성하세요 (Smartphone 일 경우)
53+
- OS: 여기에 작성하세요
54+
- Browser: 여기에 작성하세요
55+
- Version: 여기에 작성하세요
56+
57+
## 추가 내용
58+
<!-- 문제를 해결하기 위한 추가적인 정보를 알려주세요 -->
59+
여기에 작성하세요

‎.github/pull_request_template.md

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

‎.github/workflows/github_actions_cd.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: github_actions_cd
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
paths-ignore:
7+
- 'frontend/**'
8+
9+
jobs:
10+
build:
11+
runs-on: self-hosted
12+
steps:
13+
- name: pull Docker image
14+
run: sudo docker pull ${{secrets.DOCKERHUB_USERNAME}}/boarlog-backend:latest
15+
- name: delete old docker container
16+
run: sudo docker rm -f boarlog-backend-container || true
17+
- name: run docker container
18+
run: sudo docker run -d -p 8000:3000 --name boarlog-backend-container ${{secrets.DOCKERHUB_USERNAME}}/boarlog-backend

‎.github/workflows/github_actions_ci.yml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: github_actions_ci
2+
3+
on:
4+
push:
5+
branches: ["dev"]
6+
paths-ignore:
7+
- 'frontend/**'
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- name: Dockerhub Login
15+
env:
16+
DOCKER_USERNAME: ${{secrets.DOCKERHUB_USERNAME}}
17+
DOCKER_PASSWORD: ${{secrets.DOCKERHUB_TOKEN}}
18+
run: docker login -u $DOCKER_USERNAME -p $DOCKER_PASSWORD
19+
- name: Build Docker image
20+
run: docker build -t boarlog-backend ./backend
21+
- name: taging
22+
run: docker tag boarlog-backend:latest ${{secrets.DOCKERHUB_USERNAME}}/boarlog-backend:latest
23+
- name: push to Dockerhub
24+
run: docker push ${{secrets.DOCKERHUB_USERNAME}}/boarlog-backend:latest

‎.gitignore

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# compiled output
2+
/dist
3+
/node_modules
4+
5+
# Logs
6+
logs
7+
*.log
8+
npm-debug.log*
9+
pnpm-debug.log*
10+
yarn-debug.log*
11+
yarn-error.log*
12+
lerna-debug.log*
13+
14+
# OS
15+
.DS_Store
16+
17+
# Tests
18+
/coverage
19+
/.nyc_output
20+
21+
# IDEs and editors
22+
/.idea
23+
.project
24+
.classpath
25+
.c9/
26+
*.launch
27+
.settings/
28+
*.sublime-workspace
29+
30+
# IDE - VSCode
31+
.vscode/*
32+
!.vscode/settings.json
33+
!.vscode/tasks.json
34+
!.vscode/launch.json
35+
!.vscode/extensions.json
36+
37+
.env

‎README.md

+102-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,102 @@
1-
# web13_528nm
1+
2+
<img src="https://github.com/boostcampwm2023/web13_Boarlog/assets/54176384/2e33bb1f-cdcd-42df-bbc0-c9a52ab54b61" alt="boarlog logo" width='200px'/>
3+
4+
<br/>
5+
<br/>
6+
7+
8+
## 프로젝트 소개: 기록으로 남기는 실시간 강의, Boarlog
9+
10+
> **필기앱처럼 강의도 기록으로 남기면 어떨까?**
11+
12+
**Boarlog**는 교육 및 협업을 위한 실시간 화이트보드 강의 플랫폼입니다. 음성 기반 강의와 시각적 상호작용을 결합하여 참여자들에게 효과적이고 몰입도 높은 학습 경험을 제공합니다.
13+
14+
- **강의 생성 및 진행**: 강의자는 손쉽게 강의방을 열고, 음성으로 강의하며 화이트보드를 실시간으로 편집할 수 있습니다.
15+
- **강의 참여**: 참여자들은 강의에 접속하여 강의자의 음성과 화이트보드 내용을 실시간으로 볼 수 있습니다.
16+
- **상호작용 및 피드백**: 참여자들은 질문을 보내고, 강의자는 이를 포스트잇 형태로 화이트보드에 추가하여 답변할 수 있습니다.
17+
- **강의 기록 및 재생**: 강의 종료 후에는 AI를 활용하여 음성을 스크립트로 변환, 이를 화이트보드 내용과 함께 저장하여 언제든지 다시볼 수 있습니다.
18+
19+
<br/>
20+
21+
## 임시 배포 링크
22+
23+
- 화이트보드
24+
- https://boarlog.netlify.app/test
25+
- 마이크
26+
- https://boarlog.netlify.app/mictest
27+
- UI
28+
- https://boarlog.netlify.app/example
29+
30+
## 팀 소개: TEAM_528
31+
32+
```jsx
33+
const teamName = camperIdArray.reduce((team, camperId) => {
34+
return team += parseInt(camperId.replace(/[^0-9]/g, ""));
35+
}, 0)
36+
37+
// 팀에 우리를 더하다.
38+
```
39+
40+
> **5명이 모여 하나의 개발자처럼.**
41+
42+
`528`은 팀원 5명의 캠퍼 번호를 더한 숫자입니다(63+95+105+124+141).
43+
44+
5명의 캠퍼가 하나의 번호를 가지고 서로 다른 기술, 경험, 및 아이디어를 결합하여 시너지를 발휘하고자 합니다.
45+
46+
<table align=center>
47+
<thead>
48+
<tr>
49+
<th>변진상 (FE)</th>
50+
<th>이동령 (FE)</th>
51+
<th>이승연 (BE)</th>
52+
<th>이현종 (BE)</th>
53+
<th>정주완 (FE)</th>
54+
</tr>
55+
</thead>
56+
<tbody align=center>
57+
<tr>
58+
<td>
59+
<a href="https://github.com/Byeonjin"><img width="120" height="120" src="https://avatars.githubusercontent.com/u/54176384?v=4" /></a>
60+
</td>
61+
<td>
62+
<a href="https://github.com/LellowMellow"><img width="120" height="120" src="https://avatars.githubusercontent.com/u/79556112?v=4" /></a>
63+
</td>
64+
<td>
65+
<a href="https://github.com/tmddus2"><img width="120" height="120" src="https://avatars.githubusercontent.com/u/49530253?v=4" /></a>
66+
</td>
67+
<td>
68+
<a href="https://github.com/platinouss"><img width="120" height="120" src="https://avatars.githubusercontent.com/u/70827921?v=4" /></a>
69+
</td>
70+
<td>
71+
<a href="https://github.com/Jw705"><img width="120" height="120" src="https://avatars.githubusercontent.com/u/86391351?v=4" /></a>
72+
</td>
73+
</tr>
74+
<tr>
75+
<td><a href="https://github.com/Byeonjin">@Byeonjin</a></td>
76+
<td><a href="https://github.com/LellowMellow">@LellowMellow</a></td>
77+
<td><a href="https://github.com/tmddus2">@tmddus2</a></td>
78+
<td><a href="https://github.com/platinouss">@platinouss</a></td>
79+
<td><a href="https://github.com/Jw705">@Jw705</a></td>
80+
</tr>
81+
<tr align=left>
82+
<td width="200">깊이있게 고민하고 기록하기</td>
83+
<td width="200">괜한 걱정 하지 않고 차근차근 쌓아올리기</td>
84+
<td width="200">두려워하지 않고 문제 해결하기</td>
85+
<td width="200">기술 선택에 나만의 근거를 만들기</td>
86+
<td width="200">작성한 코드에 대한 의도를 잘 기록하기</td>
87+
</tr>
88+
</tbody>
89+
</table>
90+
91+
<br/>
92+
93+
## 바로가기
94+
95+
- [그라운드 룰](https://weak-sugar-603.notion.site/Ground-Rules-43ebfd44b76c482a983c4a47481028ca?pvs=4)
96+
- [branch/conmmit 컨벤션](https://weak-sugar-603.notion.site/Git-Branch-Commmit-882a35cba1cc433eb0f01abf2e3b134d?pvs=4)
97+
- [기획/디자인](https://www.figma.com/file/vd1TPvzMNwy6OfVmNFw8cI/Untitled?type=design&node-id=4%3A22&mode=design&t=NS1IQkeFYsr7lSuf-1)
98+
- [위키](https://github.com/boostcampwm2023/web13_TEAM_528/wiki)
99+
- [노션](https://weak-sugar-603.notion.site/TEAM_528-7780e03d7e9847b89fdf9f926036987b?pvs=4)
100+
- [백로그](https://www.notion.so/d1fb2080ff934e859d50c5cd3620e223)
101+
- [데모 링크](https://boarlog.netlify.app/test)
102+

‎backend/.dockerignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.git
2+
.env
3+
Dockerfile
4+
dist
5+
node_modules

‎backend/.eslintrc.js

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
module.exports = {
2+
parser: '@typescript-eslint/parser',
3+
parserOptions: {
4+
project: 'tsconfig.json',
5+
tsconfigRootDir: __dirname,
6+
sourceType: 'module',
7+
},
8+
plugins: ['@typescript-eslint/eslint-plugin'],
9+
extends: [
10+
'plugin:@typescript-eslint/recommended',
11+
'plugin:prettier/recommended',
12+
],
13+
root: true,
14+
env: {
15+
node: true,
16+
jest: true,
17+
},
18+
ignorePatterns: ['.eslintrc.js'],
19+
rules: {
20+
'@typescript-eslint/interface-name-prefix': 'off',
21+
'@typescript-eslint/explicit-function-return-type': 'off',
22+
'@typescript-eslint/explicit-module-boundary-types': 'off',
23+
'@typescript-eslint/no-explicit-any': 'off',
24+
},
25+
};

0 commit comments

Comments
 (0)