-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #168 from boostcampwm-2024/docs/update-readme
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)에서 확인하세요. 😊 |