-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loading status checks…
Docs: README.md 작성
Showing
1 changed file
with
96 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,58 +1,96 @@ | ||
# React + TypeScript + Vite | ||
|
||
This template provides a minimal setup to get React working in Vite with HMR and | ||
some ESLint rules. | ||
|
||
Currently, two official plugins are available: | ||
|
||
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) | ||
uses [Babel](https://babeljs.io/) for Fast Refresh | ||
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) | ||
uses [SWC](https://swc.rs/) for Fast Refresh | ||
|
||
## Expanding the ESLint configuration | ||
|
||
If you are developing a production application, we recommend updating the | ||
configuration to enable type aware lint rules: | ||
|
||
- Configure the top-level `parserOptions` property like this: | ||
|
||
```js | ||
export default tseslint.config({ | ||
languageOptions: { | ||
// other options... | ||
parserOptions: { | ||
project: ['./tsconfig.node.json', './tsconfig.app.json'], | ||
tsconfigRootDir: import.meta.dirname, | ||
}, | ||
}, | ||
}); | ||
``` | ||
|
||
- Replace `tseslint.configs.recommended` to | ||
`tseslint.configs.recommendedTypeChecked` or | ||
`tseslint.configs.strictTypeChecked` | ||
- Optionally add `...tseslint.configs.stylisticTypeChecked` | ||
- Install | ||
[eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and | ||
update the config: | ||
|
||
```js | ||
// eslint.config.js | ||
import react from 'eslint-plugin-react'; | ||
|
||
export default tseslint.config({ | ||
// Set the react version | ||
settings: { react: { version: '18.3' } }, | ||
plugins: { | ||
// Add the react plugin | ||
react, | ||
}, | ||
rules: { | ||
// other rules... | ||
// Enable its recommended rules | ||
...react.configs.recommended.rules, | ||
...react.configs['jsx-runtime'].rules, | ||
}, | ||
}); | ||
``` | ||
# 🍪 Ojosama | ||
|
||
![image](https://github.com/user-attachments/assets/6c8c813e-f182-4a13-bc21-cf1a7a812382) | ||
|
||
<br> | ||
|
||
## 🧑🏻💻 프론트엔드 팀 구성원 소개 | ||
|
||
<table> | ||
<tr> | ||
<td align="center" style="width:150px; padding:10px;"> | ||
<a href="https://github.com/KimKyuHoi"> | ||
<img src="https://avatars.githubusercontent.com/u/48755156?v=4" width="120px" alt=""/><br /> | ||
<sub><b>경북대 FE 김규회</b></sub> | ||
</a> | ||
<br /> | ||
</td> | ||
<td align="center" style="width:150px; padding:10px;"> | ||
<a href="https://github.com/hyunaeri"> | ||
<img src="https://avatars.githubusercontent.com/u/75007741?v=4" width="120px" alt=""/><br /> | ||
<sub><b>경북대 FE 정서현</b></sub> | ||
</a> | ||
<br /> | ||
</td> | ||
</tr> | ||
</table> | ||
|
||
<br> | ||
|
||
## 📌 목차 | ||
|
||
- [🍪 노션 페이지](#-https://quickest-asterisk-75d.notion.site/de33c852391d4e1599721de6136e9c3a) | ||
- [✨ 프로젝트 소개](#-https://quickest-asterisk-75d.notion.site/de33c852391d4e1599721de6136e9c3a?p=5f78b4ccb12246eca8f41904e9fce4d6&pm=s) | ||
- [🖥️ 배포 링크](#http://talkak-fe.s3-website.ap-northeast-2.amazonaws.com) | ||
- [🤝 그라운드 룰](#-https://quickest-asterisk-75d.notion.site/de33c852391d4e1599721de6136e9c3a?p=93d3274c7a8b4d159b38b16115c3ff42&pm=s) | ||
- [📜 커밋 컨벤션](#-https://quickest-asterisk-75d.notion.site/de33c852391d4e1599721de6136e9c3a?p=17afc129cb144bfea2fc3cea94ea153d&pm=s) | ||
- [👨💻 코딩 컨벤션](#-https://quickest-asterisk-75d.notion.site/de33c852391d4e1599721de6136e9c3a?p=833e57b063094194b6150558d89af6ec&pm=s) | ||
- [📋 API 명세서](#-https://quickest-asterisk-75d.notion.site/de33c852391d4e1599721de6136e9c3a?p=c1164ec45e4a485284644935bdb9a29f&pm=s) | ||
- [❎ 에러코드 정의서](#-https://quickest-asterisk-75d.notion.site/de33c852391d4e1599721de6136e9c3a?p=de999aae2f53421088e7edd875702089&pm=s) | ||
- [🛠️ 테스트 결과 보고서](#-https://quickest-asterisk-75d.notion.site/de33c852391d4e1599721de6136e9c3a?p=1243d1ecfbac437abbffece87f8f7c8a&pm=s) | ||
|
||
<br> | ||
|
||
## ✨ 프로젝트 소개 | ||
|
||
영상 하이라이트를 분석하여 쇼츠를 생성해주는 쇼츠 자동화 서비스 | ||
|
||
<br> | ||
|
||
## 🖥️ 배포 링크 | ||
|
||
- **Frontend**: http://talkak-fe.s3-website.ap-northeast-2.amazonaws.com | ||
|
||
- **Backend**: http://ec2-43-202-1-31.ap-northeast-2.compute.amazonaws.com | ||
|
||
<br> | ||
|
||
## ✏️ ERD 다이어그램 | ||
|
||
<img width="1053" alt="스크린샷 2024-11-15 오전 3 28 42" src="https://github.com/user-attachments/assets/20f07d26-fa07-4232-b099-b94441f2eb9f"> | ||
|
||
<br> | ||
|
||
## 🤝 그라운드 룰 | ||
|
||
[Ground Rule](https://quickest-asterisk-75d.notion.site/de33c852391d4e1599721de6136e9c3a?p=93d3274c7a8b4d159b38b16115c3ff42&pm=s) | ||
|
||
<br> | ||
|
||
## 📜 커밋 컨벤션 | ||
|
||
[Commit Convention](https://quickest-asterisk-75d.notion.site/de33c852391d4e1599721de6136e9c3a?p=17afc129cb144bfea2fc3cea94ea153d&pm=s) | ||
|
||
<br> | ||
|
||
## 👨💻 코딩 컨벤션 | ||
|
||
[Coding Convention](https://quickest-asterisk-75d.notion.site/de33c852391d4e1599721de6136e9c3a?p=833e57b063094194b6150558d89af6ec&pm=s) | ||
|
||
<br> | ||
|
||
## 📋 API 명세서 | ||
|
||
[API Docs](https://quickest-asterisk-75d.notion.site/de33c852391d4e1599721de6136e9c3a?p=c1164ec45e4a485284644935bdb9a29f&pm=s) | ||
|
||
<br> | ||
|
||
## ❎ 에러코드 정의서 | ||
|
||
[ErrorCode Definition](https://quickest-asterisk-75d.notion.site/de33c852391d4e1599721de6136e9c3a?p=de999aae2f53421088e7edd875702089&pm=s) | ||
|
||
<br> | ||
|
||
## 🛠️ 테스트 결과 보고서 | ||
|
||
[Testing Report](https://quickest-asterisk-75d.notion.site/de33c852391d4e1599721de6136e9c3a?p=1243d1ecfbac437abbffece87f8f7c8a&pm=s) |