Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] README 수정 #115

Merged
merged 3 commits into from
Nov 7, 2024
Merged

[Docs] README 수정 #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
521fadf
docs: readme 수정
simeunseo Nov 7, 2024
1a86791
docs: PR 템플릿 수정
simeunseo Nov 7, 2024
ed0a6cc
docs: figma 링크 변경
simeunseo Nov 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
## 관련 이슈 번호

<!-- 이슈를 닫지 않는다면 이유 작성하기 -->
<!-- - close #{이슈번호} -->

- close #{이슈번호}

## 작업 내용

Expand Down
83 changes: 27 additions & 56 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,61 +1,13 @@
<div align='center'>
<h1>TICLE</h1>
실시간 지식 공유 플랫폼
<br/>
<br/>
<img width="600" alt="메인 배너" src="https://github.com/user-attachments/assets/eb4c89c8-6870-4114-bddc-796b51bd7163">
<br/>

# TICLE
[:ledger: 팀 노션](https://www.notion.so/simeunseo/9-Ticle-12e599a6f0d2804682ccd2251248a435?pvs=4) | [:mag: 위키](https://github.com/boostcampwm-2024/web21-boostproject/wiki) | [🎨 피그마](https://www.figma.com/design/nw74detTvjXGrDP2cfdmwp/TICLE-%EB%94%94%EC%9E%90%EC%9D%B8?node-id=32-4477&t=3FCCnBpgQXMZs63X-1)

### "우리의 작은 지식이 모여 큰 성장이 되는 곳, TICLE"

`TICLE = Article + 티끌`

티끌모아 태산이 되듯,
작은 티클들이 모여 큰 배움이 된다는 믿음으로 이름을 지었습니다.

[:ledger: 팀 노션](https://www.notion.so/simeunseo/9-Ticle-12e599a6f0d2804682ccd2251248a435?pvs=4) | [:busts_in_silhouette: 그라운드 룰](https://github.com/boostcampwm-2024/web21-boostproject/wiki/%EA%B7%B8%EB%9D%BC%EC%9A%B4%EB%93%9C%EB%A3%B0) | [:mag: 위키](https://github.com/boostcampwm-2024/web21-boostproject/wiki) | [🎨 피그마](https://www.figma.com/board/soBcz1zqqOf8ANcBqWidTg/%EC%99%80%EC%9D%B4%EC%96%B4-%ED%94%84%EB%A0%88%EC%9E%84?node-id=0-1&t=B94Trp1LBfsoQLgn-1)

</div>

# 🛠️ 기술 스택

### 패키지 매니저

<div>
<img src="https://img.shields.io/badge/pnpm-F69220?style=for-the-badge&logo=pnpm&logoColor=white">
</div>

### 공통

<div>
<img src="https://img.shields.io/badge/typescript-3178C6?style=for-the-badge&logo=typescript&logoColor=white">
</div>

### 프론트엔드

<div>
<img src="https://img.shields.io/badge/react-61DAFB?style=for-the-badge&logo=react&logoColor=white">
<img src="https://img.shields.io/badge/tailwindcss-06B6D4?style=for-the-badge&logo=tailwindcss&logoColor=white">
<img src="https://img.shields.io/badge/reactquery-FF4154?style=for-the-badge&logo=reactquery&logoColor=white">
</div>

### 백엔드

<div>
<img src="https://img.shields.io/badge/nestjs-E0234E?style=for-the-badge&logo=nestjs&logoColor=white">
<img src="https://img.shields.io/badge/mysql-4479A1?style=for-the-badge&logo=mysql&logoColor=white">
<img src="https://img.shields.io/badge/redis-FF4438?style=for-the-badge&logo=redis&logoColor=white">
</div>

### 데브옵스

<div>
<img src="https://img.shields.io/badge/naver-03C75A?style=for-the-badge&logo=naver&logoColor=white">
<img src="https://img.shields.io/badge/githubactions-FF4438?style=for-the-badge&logo=githubactions&logoColor=white">
<img src="https://img.shields.io/badge/turborepo-EF4444?style=for-the-badge&logo=turborepo&logoColor=white">
<img src="https://img.shields.io/badge/docker-2496ED?style=for-the-badge&logo=docker&logoColor=white">
</div>

### AI

<div>
<img src="https://img.shields.io/badge/naver-03C75A?style=for-the-badge&logo=naver&logoColor=white">
</div>

# 💡 핵심 기능
Expand All @@ -65,19 +17,38 @@
카메라와 음성을 통해 발표자와 참여자가 실시간으로 지식을 공유할 수 있습니다.
화면 공유 기능으로 더욱 효과적인 지식 전달이 가능합니다.

<img width="600" alt="화면공유" src="https://github.com/user-attachments/assets/1e82dd2b-e019-44d8-a85d-12a961de38fc">

### **✔️ 티클 신청 시스템**

참여자는 티클 리스트에서 원하는 티클을 선택하고 신청할 수 있습니다.
발표자는 자신의 티클 관리 페이지에서 신청자를 확인하고 발표를 시작할 수 있습니다.

<img width="600" alt="티클 리스트(메인)" src="https://github.com/user-attachments/assets/08449986-eda7-408a-845a-cd21da718837">
<div>
<img width="300" alt="개설한 티클 관리" src="https://github.com/user-attachments/assets/9dc9627e-c806-4560-82d0-a949b1dca153">
<img width="300" alt="신청한 티클 관리" src="https://github.com/user-attachments/assets/81cf68b1-4006-4c05-9984-29d450106b2c">
</div>

### **✔️ 티클 소개 페이지**

티클 내용과 발표자 정보를 제공합니다.

<img width="600" alt="티클 개설하기" src="https://github.com/user-attachments/assets/566412dc-2045-4260-bfac-309350ac040e">

### **✔️ AI 요약 기능**

CLOVA API를 이용해 티클 내용을 요약하여 제공합니다.

# 🛠️ 기술 스택

| 분야 | 기술 |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 공통 | ![PNPM](https://img.shields.io/badge/pnpm-%234a4a4a.svg?style=for-the-badge&logo=pnpm&logoColor=f69220) ![TypeScript](https://img.shields.io/badge/typescript-3178C6?style=for-the-badge&logo=typescript&logoColor=white) |
| 프론트엔드 | ![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB) ![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white) ![React Query](https://img.shields.io/badge/-React%20Query-FF4154?style=for-the-badge&logo=react%20query&logoColor=white) |
| 백엔드 | ![NestJS](https://img.shields.io/badge/nestjs-E0234E?style=for-the-badge&logo=nestjs&logoColor=white) ![MySQL](https://img.shields.io/badge/mysql-4479A1?style=for-the-badge&logo=mysql&logoColor=white) ![Redis](https://img.shields.io/badge/redis-FF4438?style=for-the-badge&logo=redis&logoColor=white) |
| 데브옵스 | ![GitHub Actions](https://img.shields.io/badge/githubactions-FF4438?style=for-the-badge&logo=githubactions&logoColor=white) ![Turborepo](https://img.shields.io/badge/turborepo-EF4444?style=for-the-badge&logo=turborepo&logoColor=white) ![Docker](https://img.shields.io/badge/docker-2496ED?style=for-the-badge&logo=docker&logoColor=white) |

# 👋 팀원 소개

<table width="100%">
Expand Down Expand Up @@ -109,4 +80,4 @@
<td align="center">Web BE</td>
<td align="center">Web BE</td>
</tr>
</table>
</table>