-
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 branch information
1 parent
1ae87c1
commit 95f6d9b
Showing
1 changed file
with
93 additions
and
76 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,76 +1,93 @@ | ||
![KakaoTalk_Photo_2024-06-04-17-08-39](https://github.com/course-maker/Course-Maker-BE/assets/105052888/51b4f13d-3664-443a-8338-d6b4df0cf039) | ||
|
||
# ๋ถ์ฐ ์ฌํ์ฝ์ค ์ถ์ฒ ์๋น์ค | ||
|
||
|
||
## ์๋น์ค ์๊ฐ | ||
|
||
|
||
๋ถ์ฐ์ผ๋ก ๋๋ฌ๊ฐ๊ณ ์ถ์๋ฐ, ์ด๋๋ก ์ฌํ๊ฐ์ง ๊ณ ๋ฏผ์ธ๊ฐ์? | ||
|
||
์ฝ์ค๋ฉ์ด์ปค๋ฅผ ํตํด ์ฝ์ค๋ฅผ ์ถ์ฒ๋ฐ์ ๋ณด์ธ์! | ||
|
||
๋ง์์ ๋๋ ์ฝ์ค๊ฐ ์์ผ๋ฉด ์ถ์ฒ๊ณผ ์ฐ์ ํ ์ ์๊ณ | ||
|
||
์กฐํ์ ๋๋ ์ถ์ฒ์๋ก ์ ๋ ฌํด์ ์ธ๊ธฐ์๋ ์ฝ์ค๋ฅผ ๋ณผ ์๋ ์๋ต๋๋ค! | ||
|
||
์ฝ์ค๋ฅผ ์ฐพ๋ ๊ฒ ๋ฟ๋ง ์๋๋ผ ์ฝ์ค ๋ฑ๋ก์ ํด์ ๋ง์ ์ฌ๋๋ค์๊ฒ ์ฝ์ค๋ฅผ ์ถ์ฒํ ์ ์์ด์! | ||
|
||
์ผ์ ์ ์ด์์ ์ฝ์ค๋ฅผ ๋ฑ๋กํ๋ฉด ๋ฑ๊ธ๋ ์ค๋ฅด๊ณ , ๋ฑ๊ธ์ ๋ฐ๋ผ ์ฌ๋ฌ ํํ์ด ์์ด์! | ||
|
||
|
||
## ๐ ๊ธฐ์ ์คํ | ||
|
||
|
||
### ๐จ ํ๋ก ํธ์๋ | ||
|
||
<img width="692" alt="แแ ณแแ ณแ แ ตแซแแ ฃแบ 2024-06-04 17 29 00" src="https://github.com/course-maker/Course-Maker-BE/assets/105052888/89a1c93c-4a2d-4ed7-a87e-d3097829e0a1"> | ||
|
||
### ๐ณ ๋ฐฑ์๋ | ||
|
||
<img width="993" alt="แแ ณแแ ณแ แ ตแซแแ ฃแบ 2024-06-04 17 27 20" src="https://github.com/course-maker/Course-Maker-BE/assets/105052888/dab5ca64-dc20-464e-a90d-92778153b766"> | ||
|
||
|
||
|
||
## ์ธํ๋ผ | ||
|
||
|
||
![Untitled](https://github.com/course-maker/Course-Maker-BE/assets/105052888/585c33bc-178d-49cc-844a-f3534ccf88ec) | ||
|
||
## CI/CD | ||
|
||
|
||
<img width="971" alt="แแ ณแแ ณแ แ ตแซแแ ฃแบ 2024-06-04 17 26 09" src="https://github.com/course-maker/Course-Maker-BE/assets/105052888/03af73c0-080a-4bad-8327-6b76cded0130"> | ||
|
||
## ๋ฐ์ดํฐ๋ฒ ์ด์ค ๊ตฌ์กฐ | ||
|
||
|
||
<img width="1011" alt="แแ ณแแ ณแ แ ตแซแแ ฃแบ 2024-06-07 15 31 37" src="https://github.com/course-maker/Course-Maker-BE/assets/105052888/b6fcc336-aaf7-4d0b-b4b1-16d95e795fe9"> | ||
|
||
## ํ์ | ||
|
||
|
||
|
||
| ๊ธฐํ | | ||
|:---------------------------------------------------------------------------------------------------------------------------------------:| | ||
| <img src="https://avatars.githubusercontent.com/u/154443810?v=4" width=130px alt="์ด์คํฌ"> | | ||
| [์ด์คํฌ](https://github.com/yunicode914) | | ||
| ๊ธฐํ ๋ด๋น | | ||
|
||
|
||
| Frontend | Frontend | | ||
|:---------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------:| | ||
| <img src="https://avatars.githubusercontent.com/u/117327533?v=4" width=130px alt="๊นํ์"> |<img src="https://avatars.githubusercontent.com/u/88364280?v=4" width=130px alt="์ด์งํ"> | | ||
| [๊นํ์](https://github.com/hankim0904) | [์ด์งํ](https://github.com/lee-ji-hong) | | ||
| FE | FE | | ||
|
||
| Backend | Backend | Backend | Backend | | ||
|:---------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------:| | ||
| <img src="https://avatars.githubusercontent.com/u/73402982?v=4" width=130px alt="๊น์ฌํ"/> | <img src="https://avatars.githubusercontent.com/u/155591134?v=4" width=130px alt="์กํธ์ง"/> | <img src="https://avatars.githubusercontent.com/u/105052888?v=4" width=130px alt="์์ค์"/> | <img src="https://avatars.githubusercontent.com/u/46448947?v=4" width=130px alt="์ฃผ๋"> | | ||
| [๊น์ฌํ](https://github.com/YachaTree) | [์กํธ์ง](https://github.com/hojin0729) | [์์ค์](https://github.com/Derit7042) | [์ํ์ง](https://github.com/isaiahIM) | | ||
| Member ๋๋ฉ์ธ ๋ด๋น | Destination ๋๋ฉ์ธ ๋ด๋น | Course ๋๋ฉ์ธ ๋ด๋น | ํ์ฅ <br/>Tag ๋๋ฉ์ธ ๋ด๋น | | ||
|
||
|
||
|
||
|
||
|
||
# <img src="public/images/rm-logo.png" width="25" /> Readme-Monster | ||
![แแ ฆแแ ฉแจแแ ณแฏ-แแ ตแธแ แ งแจแแ ขแแ ฎแแ ฆแแ ญ_-001](https://github.com/Readme-Monster/readme-monster/assets/88364280/96e680e5-613f-4818-8603-8afbb0c9acb1) | ||
|
||
## <img src="public/images/rm-logo.png" width="20" /> RM์ ์ด๋ค ์๋น์ค์ธ๊ฐ์? | ||
- Readme Monster๋ ์ฌ์ฉ์๊ฐ ์ง๊ด์ ์ธ ์ธํฐํ์ด์ค๋ฅผ ํตํด README ํ์ผ์ ์ฝ๊ฒ ๊ตฌ์ฑํ ์ ์๊ฒ ๋์์ฃผ๊ณ , OpenAI API๋ฅผ ํ์ฉํ์ฌ ๋ง์ถคํ README ๋ด์ฉ์ ์๋์ผ๋ก ์์ฑํด์ฃผ๋ ์จ๋ผ์ธ ํ๋ซํผ์ ๋๋ค. | ||
|
||
## <img src="public/images/rm-logo.png" width="20" /> ๋งํฌ | ||
|
||
- [์๋น์ค ๋ฐ๋ก๊ฐ๊ธฐ](https://readme-monster.com/) | ||
- [๋์์ธ](https://framer.com/projects/Untitled--Xf9L3K5EqFYT1UxUF3f9-8hseT) | ||
- [Wiki](https://github.com/Readme-Monster/readme-monster/wiki) | ||
|
||
## <img src="public/images/rm-logo.png" width="20" /> RM ํ์์ ์๊ฐํฉ๋๋ค | ||
|[![](https://avatars.githubusercontent.com/u/88364280?v=4)](https://github.com/lee-ji-hong)|[![](https://avatars.githubusercontent.com/u/81367886?v=4)](https://github.com/yonghyun421)|[![](https://avatars.githubusercontent.com/u/72785296?v=4)](https://github.com/JaeHyup0504)|[![](https://avatars.githubusercontent.com/u/66737450?v=4)](https://github.com/cks612)| | ||
|:---:|:---:|:---:|:---:| | ||
| ์ด์งํ | ๊น์ฉํ | ์ด์ฌํ| ์ต๊ท์ฑ | | ||
|
||
## <img src="public/images/rm-logo.png" width="20" /> ๊ธฐ์ ์คํ | ||
|
||
- **ํ๋ก ํธ์๋** | ||
- ![Badge](https://img.shields.io/badge/React-61DAFB?style=flat&logo=react&logoColor=white) ![Badge](https://img.shields.io/badge/TypeScript-3178C6?style=flat&logo=typescript&logoColor=white) ![Badge](https://img.shields.io/badge/Tailwind_CSS-06B6D4?style=flat&logo=tailwind-css&logoColor=white) | ||
- **๋ฐฑ์๋** | ||
- ![Badge](https://img.shields.io/badge/firebase-FFCA28?style=flat&logo=firebase&logoColor=white) | ||
- **๋ฐ๋ธ์ต์ค** | ||
- ![Badge](https://img.shields.io/badge/githubactions-2088FF?style=flat&logo=githubactions&logoColor=white) | ||
- **๋๊ตฌ ๋ฐ ๋ผ์ด๋ธ๋ฌ๋ฆฌ** | ||
- ![Badge](https://img.shields.io/badge/Framer-0055FF?style=flat&logo=framer&logoColor=white) ![Badge](https://img.shields.io/badge/Context_API-5ED3F3?style=flat&logo=react&logoColor=white) ![Badge](https://img.shields.io/badge/openai-412991?style=flat&logo=openai&logoColor=white) ![Badge](https://img.shields.io/badge/git-F05032?style=flat&logo=git&logoColor=white) ![Badge](https://img.shields.io/badge/github-181717?style=flat&logo=github&logoColor=white) | ||
- **ํจํค์ง ๋งค๋์ ** | ||
- ![Badge](https://img.shields.io/badge/yarn-2C8EBB?style=flat&logo=yarn&logoColor=white) | ||
- **ํ ์คํ ** | ||
- ![Badge](https://img.shields.io/badge/jest-C21325?style=flat&logo=jest&logoColor=white) | ||
- **์ฝ๋ ํ์ง** | ||
- ![Badge](https://img.shields.io/badge/eslint-4B32C3?style=flat&logo=eslint&logoColor=white) ![Badge](https://img.shields.io/badge/prettier-F7B93E?style=flat&logo=prettier&logoColor=white) | ||
- **๋ฐฐํฌ** | ||
- ![Badge](https://img.shields.io/badge/Netlify-00C7B7?style=flat&logo=netlify&logoColor=white) | ||
|
||
## <img src="public/images/rm-logo.png" width="20" /> ๊ธฐํ ๋ฐฐ๊ฒฝ (Background) | ||
- ํ๋ก์ ํธ ๋ฌธ์ํ๋ ๊ฐ๋ฐ ๊ณผ์ ์์ ๋งค์ฐ ์ค์ํ ์ญํ ์ ํ์ง๋ง, ๋ง์ ๊ฐ๋ฐ์๋ค์ด ์ด๋ฅผ ๋ฒ๊ฑฐ๋กญ๊ณ ์๊ฐ์ด ๋ง์ด ์๋ชจ๋๋ ์์ ์ผ๋ก ์ฌ๊ฒจ ์๋ตํ๊ฑฐ๋ ์ฐ์ ์์๋ฅผ ๋ฏธ๋ฃจ๋ ๊ฒฝ์ฐ๊ฐ ๋ง์ต๋๋ค. | ||
|
||
- ์ด๋ฌํ ๋ฌธ์ ์ธ์์์ ์ถ๋ฐํ README ์๋ ์์ฑ ๋๊ตฌ๋ ๋ค์๊ณผ ๊ฐ์ ๊ธฐํ ๋ฐฐ๊ฒฝ์ ๊ฐ์ง๊ณ ์์ต๋๋ค. | ||
|
||
|
||
### <img src="public/images/rm-logo.png" width="15" /> ๋๊ธฐ ๋ฐ ํ์์ฑ | ||
|
||
- **ํจ์จ์ฑ ์ฆ๋** | ||
- ๊ฐ๋ฐ์๋ค์ด ํ๋ก์ ํธ์ ๊ธฐ๋ณธ ๊ตฌ์กฐ์ ๋ด์ฉ์ ๋น ๋ฅด๊ฒ ๋ฌธ์ํํ ์ ์๋๋ก ๋์ต๋๋ค. | ||
์ด๋ ํ๋ก์ ํธ ์์ ๋จ๊ณ์์ ๋ง์ ์๊ฐ์ ์ ์ฝํ ์ ์๊ฒ ํฉ๋๋ค. | ||
- **ํ์คํ๋ ๋ฌธ์** | ||
- README ํ์ผ์ ํ๋ก์ ํธ๋ฅผ ์ดํดํ๋ ๋ฐ ํ์์ ์ธ ์์์ ๋๋ค. ์๋ ์์ฑ ๋๊ตฌ๋ ํ๋ก์ ํธ์ ๊ธฐ๋ณธ ์ ๋ณด, ์ค์น ๋ฐฉ๋ฒ, ์ฌ์ฉ ๋ฐฉ๋ฒ ๋ฑ์ ํ์คํ๋ ํ์์ผ๋ก ์ ๊ณตํจ์ผ๋ก์จ ํ๋ก์ ํธ์ ์ ๋ฌ๋ ฅ์ ๋์ ๋๋ค. | ||
- **์ฌ์ฉ์ ๊ฒฝํ ๊ฐ์ ** | ||
- ๋ช ํํ๊ณ ์ง๊ด์ ์ธ ๋ฌธ์๋ ์ฌ์ฉ์๋ ๊ธฐ์ฌ์๊ฐ ํ๋ก์ ํธ์ ์ฝ๊ฒ ์ ๊ทผํ ์ ์๋๋ก ๋์ต๋๋ค. ์ด๋ ๊ฐ๋ฐฉ์ฑ๊ณผ ํ๋ ฅ์ ์ฆ์ง์ํค๋ ํจ๊ณผ๊ฐ ์์ต๋๋ค. | ||
|
||
### <img src="public/images/rm-logo.png" width="15" /> ์ฌ์ฉ์ ๋ฌธ์ ํด๊ฒฐ | ||
|
||
- ์ด ๋๊ตฌ๋ ํนํ ๋ฌธ์ ์์ฑ์ ์ต์ํ์ง ์๊ฑฐ๋, ๋ฌธ์ ์์ฑ์ ๋ฒ๊ฑฐ๋กญ๊ฒ ์๊ฐํ๋ ๊ฐ๋ฐ์๋ค์ ์ํด ์ค๊ณ๋์์ต๋๋ค. | ||
- ๋ํ, ํ๋ก์ ํธ ๋ฌธ์์ ํ์ง๊ณผ ์ผ๊ด์ฑ์ ์ ์งํ๊ณ ์ถ์ดํ๋ ํ๋ก์ ํธ ๊ด๋ฆฌ์๋ ํ ๋ฆฌ๋์๊ฒ๋ ์ ์ฉํฉ๋๋ค. | ||
|
||
### <img src="public/images/rm-logo.png" width="15" /> ์ด์ ์๋ ๋ฐ ๊ฐ์ ์ | ||
|
||
- ๊ณผ๊ฑฐ์๋ ํ๋ก์ ํธ ๋ฌธ์ํ๋ฅผ ์๋ํํ๋ ค๋ ๋ค์ํ ์๋๊ฐ ์์์ต๋๋ค. ์ด๋ฌํ ๋๊ตฌ๋ค์ ์ฃผ๋ก ํ ํ๋ฆฟ ๊ธฐ๋ฐ์ ์ ๊ทผ ๋ฐฉ์์ ์ฑํํ์ผ๋, ์ฌ์ฉ์์ ๊ฐ๋ณ ์๊ตฌ์ฌํญ์ ์ถฉ๋ถํ ๋ฐ์ํ์ง ๋ชปํ๋ ๊ฒฝ์ฐ๊ฐ ๋ง์์ต๋๋ค. | ||
- ์ต์ README ์๋ ์์ฑ ๋๊ตฌ๋ค์ ์ด๋ฌํ ํ๊ณ๋ฅผ ๊ทน๋ณตํ๊ธฐ ์ํด ๋์ฑ ์ธ๋ จ๋๊ณ ์ฌ์ฉ์ ์นํ์ ์ธ ๊ธฐ๋ฅ์ ์ ๊ณตํ๋ ค๊ณ ํฉ๋๋ค. ์๋ฅผ ๋ค์ด, ํ๋ก์ ํธ ๊ตฌ์กฐ๋ฅผ ์๋ ๋ถ์ํ์ฌ ๊ด๋ จ ์น์ ์ ์๋์ผ๋ก ์์ฑํ๊ณ , ์ฌ์ฉ์๊ฐ ํน์ ๋ด์ฉ์ ์ฝ๊ฒ ์ถ๊ฐํ๊ฑฐ๋ ์์ ํ ์ ์๋ ์ต์ ์ ์ ๊ณตํฉ๋๋ค. ์ด๋ฌํ ๋ฐ์ ์ ๊ฐ๋ฐ์ ์ปค๋ฎค๋ํฐ์ ํผ๋๋ฐฑ๊ณผ ๊ธฐ์ ๋ฐ์ ์ ํตํด ๊ฐ๋ฅํด์ก์ต๋๋ค. | ||
|
||
--- | ||
|
||
- **์ด๋ฌํ ๋ฐฐ๊ฒฝ๊ณผ ๋๊ธฐ๋ README ์๋ ์์ฑ ๋๊ตฌ๊ฐ ๊ฐ๋ฐ์๋ค ์ฌ์ด์์ ํ์ํ ํด๊ฒฐ์ฑ ์ด์์์ ๋ณด์ฌ์ค๋๋ค. ์ด ๋๊ตฌ๋ ํ๋ก์ ํธ ๋ฌธ์ํ ๊ณผ์ ์ ๊ฐ์ํํ๊ณ , ๊ฐ๋ฐ์๋ค์ด ๋ณด๋ค ์ค์ํ ๊ฐ๋ฐ ์์ ์ ๋ ๋ง์ ์๊ฐ์ ํ ์ ํ ์ ์๋๋ก ์ง์ํฉ๋๋ค.** | ||
|
||
## <img src="public/images/rm-logo.png" width="20" /> ์ค์น ๋ฐฉ๋ฒ | ||
|
||
yarn ๋ฐฉ์์ผ๋ก ์ค์นํด์ฃผ์ธ์ | ||
|
||
```bash | ||
yarn install | ||
yarn start | ||
``` | ||
|
||
## <img src="public/images/rm-logo.png" width="20" /> ์ฌ์ฉ ๋ฐฉ๋ฒ | ||
1. Readme-Monster์ ์ ์ํฉ๋๋ค. | ||
<img src="public/images/rm2.png" /> | ||
2. ํ์๊ฐ์ ๋ฐ ๋ก๊ทธ์ธ์ ํฉ๋๋ค. (๋ก๊ทธ์ธ์ ํ์ง ์์๋ ์ฌ์ฉ ๊ฐ๋ฅํฉ๋๋ค.) | ||
<img src="public/images/rm4.png"> | ||
<img src="public/images/rm3.png"> | ||
3. ์ํ๋ ์น์ ์ ์ ํํ๊ณ , ํด๋นํ๋ ๋ด์ฉ์ ์ ๋ ฅํ์ฌ Readme ํ์ผ์ ์์ฑํฉ๋๋ค. ์์ฑํ ํ์ผ์ ๋ณต์ฌํ์ฌ ์ฌ์ฉํ๊ฑฐ๋, ๋ค์ด๋ก๋ํ์ฌ ์ฌ์ฉํ ์ ์์ต๋๋ค. | ||
<img src="public/images/rm5.png"> | ||
4. ์๋์ผ๋ก Readme ํ์ผ์ ์์ฑํ๋ ๊ธฐ๋ฅ์ ์ฌ์ฉํ๋ ค๋ฉด, Auto ํญ์ผ๋ก ์ด๋ํ์ฌ ๋ ํฌ์งํ ๋ฆฌ ์ฃผ์์ OpenAI API Key๋ฅผ ์ ๋ ฅํ๊ณ ํ๋ก์ ํธ์ ๋ํ ๊ฐ๋จํ ์ค๋ช ์ ์ ๋ ฅํ ํ ์์ฑ ๋ฒํผ์ ๋๋ฆ ๋๋ค. | ||
<img src="public/images/rm8.png"> | ||
5. ์๋จ์ ํ๋กํ ์์ด์ฝ์ ํด๋ฆญํ์ฌ ํ๋กํ ํ์ด์ง๋ก ์ด๋ํ ์ ์์ต๋๋ค. ํ๋กํ ํ์ด์ง์์๋ ์์ ์ด ์์ฑํ Readme ํ์ผ์ ํ์ธํ ์ ์์ต๋๋ค. | ||
<img src="public/images/rm9.png"> | ||
6. ๋ก๊ทธ์์์ ํ๋ ค๋ฉด ํ๋กํ ํ์ด์ง์์ ๋ก๊ทธ์์ ๋ฒํผ์ ํด๋ฆญํฉ๋๋ค. | ||
<img src="public/images/rm11.png"> | ||
7. Readme-Monster๋ฅผ ์ด์ฉํ๋ฉด์ ๋ถํธํ ์ ์ด๋ ๊ฐ์ ์ฌํญ์ด ์๋ค๋ฉด, ์๋จ์ ๋งํ์ ์์ด์ฝ์ ํด๋ฆญํ์ฌ ํผ๋๋ฐฑ์ ๋จ๊ฒจ์ฃผ์ธ์. | ||
<img src="public/images/rm6.png"> | ||
8. ์๋จ์ ๋ผ์ดํธ๋ชจ๋/๋คํฌ๋ชจ๋ ๋ฒํผ์ ํด๋ฆญํ์ฌ ํ๋ฉด์ ๋ณ๊ฒฝํ ์ ์์ต๋๋ค. | ||
<img src="public/images/rm7.png"> |