Skip to content

Commit

Permalink
๐Ÿ“ Docs: readme ์ „๋ฐ˜์ ์ธ ์ˆ˜์ •
Browse files Browse the repository at this point in the history
  • Loading branch information
Gdm0714 committed Nov 30, 2024
1 parent 888298a commit 22027fa
Showing 1 changed file with 77 additions and 31 deletions.
108 changes: 77 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,106 @@
# Cloud Canvas

<h1 align="center">
<p align="middle" >
<img src="https://github.com/user-attachments/assets/10ca29c8-f363-431e-8e80-4ac5e869745b" alt="Cloud Canvas" width="300" height="300"/>
</h1>
</p>

<h2 align="center">๐ŸŽจ Cloud Canvas ๐ŸŽจ</h2>
<p align="middle">์‰ฝ๊ณ  ๋น ๋ฅด๊ฒŒ, ๋ˆ„๊ตฌ๋‚˜ ํด๋ผ์šฐ๋“œ๋ฅผ ์„ค๊ณ„ํ•˜๋Š” ์ฆ๊ฑฐ์šด ๊ฒฝํ—˜์„!</p>

## **Cloud Canvas๋ž€?** โœจ

Cloud Canvas๋Š” ํด๋ผ์šฐ๋“œ ์ธํ”„๋ผ ์„ค๊ณ„๋ฅผ **๊ทธ๋ž˜ํ”ฝ ์ธํ„ฐํŽ˜์ด์Šค**๋กœ ๊ฐ„๋‹จํ•˜๊ณ  ์ง๊ด€์ ์œผ๋กœ ํ•  ์ˆ˜ ์žˆ๋Š” **ํ˜์‹ ์ ์ธ ๋„๊ตฌ**์ž…๋‹ˆ๋‹ค.
๊ตญ๋‚ด ํด๋ผ์šฐ๋“œ ํ”Œ๋žซํผ์„ ์ ๊ทน ์ง€์›ํ•˜๋ฉฐ, **Terraform ์ฝ”๋“œ ๋ณ€ํ™˜**๊นŒ์ง€ ๊ฐ€๋Šฅํ•œ **์˜ฌ์ธ์› ์ธํ”„๋ผ ๊ด€๋ฆฌ ํ”Œ๋žซํผ**์ž…๋‹ˆ๋‹ค.

> **๊ตญ๋‚ด ํด๋ผ์šฐ๋“œ์—๋„ ์ด๋Ÿฐ ๋„๊ตฌ๊ฐ€ ํ•„์š”ํ•˜์ง€ ์•Š์œผ์…จ๋‚˜์š”?**
> Cloud Canvas์™€ ํ•จ๊ป˜ **๋” ์‰ฝ๊ณ , ๋” ๋น ๋ฅด๊ณ , ๋” ์ฆ๊ฒ๊ฒŒ** ํด๋ผ์šฐ๋“œ ์ธํ”„๋ผ๋ฅผ ์„ค๊ณ„ํ•˜์„ธ์š”!
---

## **ํ”„๋กœ์ ํŠธ ๋น„์ „** ๐Ÿš€

### ์™œ Cloud Canvas์ธ๊ฐ€?

**๊ฐœ๋ฐœ์ž๋“ค์˜ ๊ณตํ†ต๋œ ๊ณ ๋ฏผ**

- ๋ฐ˜๋ณต๋˜๋Š” ์ˆ˜์ž‘์—…์œผ๋กœ ํด๋ผ์šฐ๋“œ ๋ฆฌ์†Œ์Šค๋ฅผ ๊ด€๋ฆฌํ•ด์•ผ ํ•˜๋Š” ๋ถˆํŽธํ•จ.
- ํด๋ผ์šฐ๋“œ ํ”Œ๋žซํผ์˜ ๋ณต์žกํ•œ ์ธํ„ฐํŽ˜์ด์Šค์— ์ ์‘ํ•˜๋Š” ๋ฐ ํ•„์š”ํ•œ ์‹œ๊ฐ„๊ณผ ๋…ธ๋ ฅ.
- ๊ตญ๋‚ด ํด๋ผ์šฐ๋“œ ์„œ๋น„์Šค์— ์ ํ•ฉํ•œ ํˆด ๋ถ€์žฌ.

**์šฐ๋ฆฌ์˜ ํ•ด๋‹ต**

## ๐Ÿ“Œ ํ”„๋กœ์ ํŠธ ๋ฐฐ๊ฒฝ
- **Cloud Canvas๋Š” ๊ตญ๋‚ด ํด๋ผ์šฐ๋“œ ํ”Œ๋žซํผ์„ ๋ชฉํ‘œ๋กœ ํ•˜๋Š” GUI ๊ธฐ๋ฐ˜ ๋„๊ตฌ**์ž…๋‹ˆ๋‹ค.
ํด๋ฆญ ๋ช‡ ๋ฒˆ์œผ๋กœ ์™„์„ฑ๋˜๋Š” ์„ค๊ณ„๋ถ€ํ„ฐ Terraform ์ฝ”๋“œ ๋ณ€ํ™˜๊นŒ์ง€, Cloud Canvas๊ฐ€ ์—ฌ๋Ÿฌ๋ถ„์˜ ์‹œ๊ฐ„์„ ์•„๊ปด๋“œ๋ฆฝ๋‹ˆ๋‹ค.

ํด๋ผ์šฐ๋“œ ์ธํ”„๋ผ ๊ตฌ์ถ• ๊ณผ์ •์—์„œ ๊ฐœ๋ฐœ์ž๋“ค์€ ๋‹ค์Œ๊ณผ ๊ฐ™์€ ์–ด๋ ค์›€์„ ๊ฒช๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค
---

- **๋ฐ˜๋ณต์ ์ธ ์ˆ˜์ž‘์—…**: ํด๋ผ์šฐ๋“œ ์ฝ˜์†”์—์„œ ๊ฐ ๋ฆฌ์†Œ์Šค๋งˆ๋‹ค ๋ณ„๋„์˜ ํŽ˜์ด์ง€์— ์ ‘์†ํ•˜์—ฌ ์ƒ์„ฑํ•˜๋Š” ๊ณผ์ •์„ ๋ฐ˜๋ณตํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.
- **ํ”Œ๋žซํผ ์ ์‘ ์‹œ๊ฐ„**: ํด๋ผ์šฐ๋“œ ์—…์ฒด๋ณ„๋กœ ์ƒ์ดํ•œ ์ธํ„ฐํŽ˜์ด์Šค๋กœ ์ธํ•ด, ์ƒˆ๋กœ์šด ํ”Œ๋žซํผ ์‚ฌ์šฉ ์‹œ ์ถ”๊ฐ€์ ์ธ ํ•™์Šต ์‹œ๊ฐ„์ด ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค.
## **ํ”„๋กœ์ ํŠธ ๋ชฉํ‘œ** ๐ŸŽฏ

์ด๋Ÿฌํ•œ ์ธํ”„๋ผ ๊ด€๋ฆฌ ์ž‘์—…๋“ค๋กœ ์ธํ•ด ํ•ต์‹ฌ ๊ฐœ๋ฐœ ์—…๋ฌด์— ์ง‘์ค‘ํ•˜๊ธฐ ์–ด๋ ค์›Œ์ง‘๋‹ˆ๋‹ค.
### ๐Ÿ–Œ๏ธ **์ง๊ด€์ ์ธ UX/UI**

์ตœ๊ทผ์—๋Š” ์œ„์˜ ๋ฌธ์ œ๋“ค์„ ํ•ด๊ฒฐํ•˜๊ธฐ ์œ„ํ•œ ๋„๊ตฌ๋“ค์ด ์ œ๊ณต๋˜๊ณ  ์žˆ์ง€๋งŒ, ๋‹ค์Œ๊ณผ ๊ฐ™์€ ํ•œ๊ณ„์ ์„ ๊ฐ€์ง€๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค.
- ๋ˆ„๊ตฌ๋‚˜ ์‰ฝ๊ฒŒ ํด๋ผ์šฐ๋“œ ์ธํ”„๋ผ๋ฅผ ์„ค๊ณ„ํ•  ์ˆ˜ ์žˆ๋Š” **์ง๊ด€์ ์ด๊ณ  ์„ธ๋ จ๋œ ์ธํ„ฐํŽ˜์ด์Šค** ์ œ๊ณต.

- **Terraform ๋“ฑ IaC ๋„๊ตฌ**: ๋†’์€ ๋Ÿฌ๋‹ ์ปค๋ธŒ์™€ Terraform์„ ํ™œ์šฉํ•˜์—ฌ ํ”„๋กœ์ ํŠธ๋ฅผ ๊ด€๋ฆฌํ•˜๋Š” ๋ฐฉ๋ฒ•์„ ํ•™์Šตํ•˜๋Š” ๋ฐ ๊ฐœ๋ฐœ์ž๋“ค์ด ์‹œ๊ฐ„์„ ํˆฌ์žํ•˜์—ฌ์•ผ ํ•ฉ๋‹ˆ๋‹ค.
- **AWS CloudFormation Design, CloudCraft ๋“ฑ GUI ์ธํ”„๋ผ ์„ค๊ณ„ ๋„๊ตฌ**: AWS CloudFormation Design์€ AWS ์ „์šฉ์œผ๋กœ ์ œ๊ณตํ•˜๋Š” ๊ธฐ๋Šฅ์ด๋ฉฐ, CloudCraft๋Š” ์™ธ๊ตญ์˜ ํด๋ผ์šฐ๋“œ ์—…์ฒด๋งŒ์„ ๋Œ€์ƒ์œผ๋กœ ํ•˜๊ธฐ์— ๊ตญ๋‚ด ํด๋ผ์šฐ๋“œ ์—…์ฒด๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ๊ฐœ๋ฐœ์ž๋“ค์ด ํ•ด๋‹น ๋„๊ตฌ๋“ค์„ ์‚ฌ์šฉํ•  ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค.
### ๐Ÿ”ง **์ž๋™ํ™”๋œ Terraform ์ฝ”๋“œ ๋ณ€ํ™˜**

๋”ฐ๋ผ์„œ ์ €ํฌ Cloud-Canvas ํŒ€์€ ๊ตญ๋‚ด ํด๋ผ์šฐ๋“œ ์—…์ฒด๋„ ์ง€์›ํ•˜๋Š” GUI ๊ธฐ๋ฐ˜์˜ ์ธํ”„๋ผ ํ†ตํ•ฉ ๊ด€๋ฆฌ ์‹œ์Šคํ…œ์— ํ•„์š”์„ฑ์„ ๋Š๋ผ๊ฒŒ ๋˜์—ˆ์Šต๋‹ˆ๋‹ค.
- ์„ค๊ณ„๋œ ์ธํ”„๋ผ๋ฅผ **Terraform ์ฝ”๋“œ๋กœ ๋ณ€ํ™˜**ํ•˜์—ฌ ๋‹ค์šด๋กœ๋“œ ๊ฐ€๋Šฅ.

## ๐Ÿ“Œ ํ”„๋กœ์ ํŠธ ์†Œ๊ฐœ
### ๐ŸŒ **์ธํ”„๋ผ ํ—ˆ๋ธŒ ๊ธฐ๋Šฅ**

Cloud-Canvas๋Š” ์ด๋Ÿฌํ•œ ๋ฌธ์ œ์ ์„ ํ•ด๊ฒฐํ•˜๊ธฐ ์œ„ํ•œ GUI ๊ธฐ๋ฐ˜ ์ธํ”„๋ผ ๊ด€๋ฆฌ ๋„๊ตฌ์ž…๋‹ˆ๋‹ค.
- ์„ค๊ณ„ํ•œ ์ธํ”„๋ผ๋ฅผ **๊ณต์œ ํ•˜๊ณ  ์žฌํ™œ์šฉ**ํ•  ์ˆ˜ ์žˆ๋Š” ์ปค๋ฎค๋‹ˆํ‹ฐ ์ œ๊ณต.
- ๋‹ค๋ฅธ ์‚ฌ์šฉ์ž์˜ ์ธํ”„๋ผ๋ฅผ **์ˆ˜์ •, ํ™œ์šฉ**ํ•˜์—ฌ ์ž์‹ ๋งŒ์˜ ์„ค๊ณ„๋ฅผ ์™„์„ฑ.

## ๐Ÿ“Œ ํ”„๋กœ์ ํŠธ ๊ธฐ๋Œ€ ํšจ๊ณผ
---

- ๊ธฐ์กด AWS ์‚ฌ์šฉ์ž๋“ค์˜ ๊ตญ๋‚ด ํด๋ผ์šฐ๋“œ ์ƒํƒœ๊ณ„ ์œ ์ž… ์ด‰์ง„
- ๊ตญ๋‚ด ํด๋ผ์šฐ๋“œ ์„œ๋น„์Šค ํ™œ์„ฑํ™”
- ํ•œ๊ตญ ํด๋ผ์šฐ๋“œ ์‚ฐ์—…์˜ ๊ฒฝ์Ÿ๋ ฅ ๊ฐ•ํ™”
## **Cloud Canvas์˜ ๊ธฐ๋Œ€ ํšจ๊ณผ** ๐ŸŒŸ

## ๐Ÿ“Œ ํ”„๋กœ์ ํŠธ ๋ชฉํ‘œ
1. **๋ฐ˜๋ณต ์ž‘์—… ์ตœ์†Œํ™”**
- GUI๋กœ ๋น ๋ฅด๊ณ  ํšจ์œจ์ ์ธ ์„ค๊ณ„ ๊ฐ€๋Šฅ.
2. **๊ตญ๋‚ด ํด๋ผ์šฐ๋“œ ์ƒํƒœ๊ณ„ ํ™œ์„ฑํ™”**
- AWS ์‚ฌ์šฉ์ž๋“ค์ด ๊ตญ๋‚ด ํด๋ผ์šฐ๋“œ ํ”Œ๋žซํผ์œผ๋กœ ์‰ฝ๊ฒŒ ์œ ์ž….
3. **ํ•œ๊ตญ ํด๋ผ์šฐ๋“œ ์‚ฐ์—… ๊ฒฝ์Ÿ๋ ฅ ๊ฐ•ํ™”**
- ๊ธ€๋กœ๋ฒŒ ์‹œ์žฅ์—์„œ๋„ ๊ฒฝ์Ÿ ๊ฐ€๋Šฅํ•œ ํ˜์‹ ์  ๋„๊ตฌ.

- ์ง๊ด€์ ์ธ UX/UI๋ฅผ ํ†ตํ•œ ์ธํ”„๋ผ ์„ค๊ณ„ ๊ธฐ๋Šฅ ์ œ๊ณต
- ์‹ค์‹œ๊ฐ„ ๋ชจ๋‹ˆํ„ฐ๋ง์„ ํ†ตํ•œ ํšจ์œจ์ ์ธ ์ธํ”„๋ผ ๊ด€๋ฆฌ ๊ธฐ๋Šฅ ์ œ๊ณต
- ๊ตญ๋‚ด์™ธ ํด๋ผ์šฐ๋“œ ์—…์ฒด ํ†ตํ•ฉ ๊ด€๋ฆฌ ๊ธฐ๋Šฅ ์ œ๊ณต
- NPM ๋ชจ๋“ˆ์„ ํ†ตํ•ด ์ œ๊ณตํ•จ์œผ๋กœ์จ, ์ž๋ฐ”์Šคํฌ๋ฆฝํŠธ ๊ฐœ๋ฐœ์ž๋“ค์—๊ฒŒ ์นœํ™”์ ์ธ ๋„๊ตฌ๋ฅผ ์ œ์ž‘
- Infra Hub๋ฅผ ํ†ตํ•ด ์‚ฌ์šฉ์ž๊ฐ€ ์ž์‹ ์ด ์„ค๊ณ„ํ•œ ์ธํ”„๋ผ๋ฅผ ์ „ ์„ธ๊ณ„ ์‚ฌ๋žŒ๋“ค๊ณผ ๊ณต์œ ํ•  ์ˆ˜ ์žˆ๋„๋ก ํ•จ
---

## ๐Ÿ“Œ ์•„ํ‚คํ…์ณ
## **๊ธฐ์ˆ  ์Šคํƒ** ๐Ÿ› 

### ์ „๋ฐ˜์ ์ธ ์ธํ”„๋ผ
### ๐Ÿ“Œ **Frontend**

- **React 18.3.1**
- **Vite 5.4.9**

### ๐Ÿ“Œ **Backend**

- **TypeScript 5.1.3**
- **NestJS 10.0.0**
- **Prisma 5.22.0**
- **Vitest 2.1.4**
- **MySQL**

---

## **์•„ํ‚คํ…์ฒ˜** ๐ŸŒ

### **์ „๋ฐ˜์ ์ธ ์ธํ”„๋ผ ์„ค๊ณ„**

![image](https://github.com/user-attachments/assets/5901b688-0d3d-4698-ad22-a4d4bb7aa8fd)

### CI/CD
### **CI/CD ํŒŒ์ดํ”„๋ผ์ธ**

<img width="1024" alt="cicd" src="https://github.com/user-attachments/assets/286d7d2d-bb6a-4315-bcff-4a6ea7569077">

# ํŒ€
## **ํŒ€ ์†Œ๊ฐœ** ๐Ÿ‘ฉโ€๐Ÿ’ป

> ๋‹ค์–‘ํ•œ ๋ฐฐ๊ฒฝ๊ณผ ๊ฒฝํ—˜์„ ๊ฐ€์ง„ ๋„ค ๋ช…์˜ ํŒ€์›์ด Cloud Canvas๋ฅผ ๋งŒ๋“ค๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค.
| ๊น€๋ฒ”์ค€ | ๊ณ ๋™๋ฏผ | ์ตœ์žฌ์˜ | ์„œ๊ฑดํ˜ |
| **๊น€๋ฒ”์ค€** | **๊ณ ๋™๋ฏผ** | **์ตœ์žฌ์˜** | **์„œ๊ฑดํ˜** |
| :--------------------------------------------------------: | :-------------------------------------------------------: | :-------------------------------------------------------: | :-------------------------------------------------------: |
| FE | BE | BE | BE |
| **FE** | **BE** | **BE** | **BE** |
| [p1n9](https://github.com/p1n9d3v) | [Gdm0714](https://github.com/Gdm0714) | [paulcjy](https://github.com/paulcjy) | [SeoGeonhyuk](https://github.com/SeoGeonhyuk) |
| ![](https://avatars.githubusercontent.com/u/152015839?v=4) | ![](https://avatars.githubusercontent.com/u/50660440?v=4) | ![](https://avatars.githubusercontent.com/u/86853786?v=4) | ![](https://avatars.githubusercontent.com/u/60954160?v=4) |
| ์ปคํ”ผ | ๋นต | ๊ณ ๊ธฐ | ๊ตญ์ˆ˜ |

---

## ๐ŸŒˆ **ํ•จ๊ป˜ํ•˜์„ธ์š”!**

> **Cloud Canvas๋กœ ํด๋ผ์šฐ๋“œ ์„ค๊ณ„์˜ ์ƒˆ๋กœ์šด ๊ฐ€๋Šฅ์„ฑ์„ ๊ฒฝํ—˜ํ•ด๋ณด์„ธ์š”!**
> ํ”„๋กœ์ ํŠธ์˜ ์ง„ํ–‰ ์ƒํ™ฉ๊ณผ ๋” ๋งŽ์€ ์ •๋ณด๋ฅผ ์›ํ•˜์‹ ๋‹ค๋ฉด [GitHub Wiki](https://github.com/boostcampwm-2024/web37-cloud-canvas/wiki)์—์„œ ํ™•์ธํ•˜์„ธ์š”. ๐Ÿ˜Š

0 comments on commit 22027fa

Please sign in to comment.