-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
๐ Docs: readme ์ ๋ฐ์ ์ธ ์์
- Loading branch information
Showing
1 changed file
with
77 additions
and
31 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,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)์์ ํ์ธํ์ธ์. ๐ |