Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hyonun321 authored Nov 14, 2024
1 parent f2744c1 commit cf6bcdf
Showing 1 changed file with 45 additions and 36 deletions.
81 changes: 45 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
![Group 38 (1)](https://github.com/user-attachments/assets/a882c5c5-b205-43cc-9a16-2f5e87dbd6aa)

## πŸ“‹ ν”„λ‘œμ νŠΈ 이름 : `Nocta`

![image](https://github.com/user-attachments/assets/ce48d2e5-ca40-43e6-8d64-0f874312f065)
<p align="center">
<a href="https://223.130.159.220" title="🌌 λ°€ν•˜λŠ˜μ˜ λ³„λΉ›μ²˜λŸΌ, 자유둜운 μΈν„°λž™μ…˜ μ‹€μ‹œκ°„ 에디터"><strong>배포 μ‚¬μ΄νŠΈ</strong></a>
</p>

## `Nocta`

> 🌌 λ°€ν•˜λŠ˜μ˜ λ³„λΉ›μ²˜λŸΌ, 자유둜운 μΈν„°λž™μ…˜ μ‹€μ‹œκ°„ 에디터
- μ‹€μ‹œκ°„ 기둝 ν˜‘μ—… μ†Œν”„νŠΈμ›¨μ–΄μž…λ‹ˆλ‹€.

## πŸ‘©β€πŸ’» νŒ€ 이름 : `Glassmo` (κΈ€λž˜μŠ€λͺ¨)
## `Team Glassmo`

- κΈ€λž˜μŠ€λͺ¨ν”Όμ¦˜μ˜ μ•½μž

Expand All @@ -22,6 +28,31 @@
| FE+BE | FE | BE | FE |
| [@hyonun321](https://github.com/hyonun321) | [@Ludovico7](https://github.com/Ludovico7) | [@minjungw00](https://github.com/minjungw00) | [@pipisebastian](https://github.com/pipisebastian) |


## ν”„λ‘œμ νŠΈ κΈ°λŠ₯ μ†Œκ°œ
### 1. νŽ˜μ΄μ§€ 생성, λ“œλž˜κ·Έ μ•€ λ“œλž

μ‚¬μ΄λ“œλ°”μ˜ νŽ˜μ΄μ§€ μΆ”κ°€ λ²„νŠΌμ„ 톡해 νŽ˜μ΄μ§€λ₯Ό μƒμ„±ν•˜κ³  관리할 수 μžˆμŠ΅λ‹ˆλ‹€.

![111111](https://github.com/user-attachments/assets/7bbbd091-a906-49b1-8043-13240bdf2f5b)

### 2. νƒ­ λΈŒλΌμš°μ§•: μ΅œμ†Œν™” μ΅œλŒ€ν™” λ¦¬μ‚¬μ΄μ¦ˆ

각각의 λ¬Έμ„œλ₯Ό νƒ­λΈŒλΌμš°μ§• λ°©μ‹μœΌλ‘œ 관리할 수 μžˆμŠ΅λ‹ˆλ‹€. 크기λ₯Ό μ‘°μ ˆν•˜κ±°λ‚˜ λ“œλž˜κ·Έ μ•€ λ“œλžμ„ 톡해 μ›ν•˜λŠ” μœ„μΉ˜μ— μœ„μΉ˜μ‹œν‚¬ 수 μžˆμŠ΅λ‹ˆλ‹€.

![22222](https://github.com/user-attachments/assets/7355a84a-7ff5-44c5-a3d0-24840a468818)

### 3. μ‹€μ‹œκ°„ λ§ˆν¬λ‹€μš΄ νŽΈμ§‘

λ§ˆν¬λ‹€μš΄ 문법을 μž…λ ₯ν•˜λ©΄ μ‹€μ‹œκ°„μœΌλ‘œ λ§ˆν¬λ‹€μš΄ λ¬Έλ²•μœΌλ‘œ λ³€ν™˜ν•©λ‹ˆλ‹€.

![33333](https://github.com/user-attachments/assets/ffcf7fa5-9436-4e6b-b38f-6fbf9e813cb5)

### 4.μ‹€μ‹œκ°„ λ™μ‹œνŽΈμ§‘(κ΅¬ν˜„μ€‘)

ν•˜λ‚˜μ˜ λ¬Έμ„œλ₯Ό μ—¬λŸ¬ μ‚¬μš©μžκ°€ λ™μ‹œμ— νŽΈμ§‘μ΄ κ°€λŠ₯ν•©λ‹ˆλ‹€. CRDT μ•Œκ³ λ¦¬μ¦˜μ„ 톡해 μ‹€μ‹œκ°„ 변경사항을 λͺ¨λ“  μ‚¬μš©μžμ—κ²Œ λ°˜μ˜ν•©λ‹ˆλ‹€.


## πŸ”§ 기술 μŠ€νƒ

**Common**
Expand All @@ -34,59 +65,37 @@

**Backend**

<div align="left"> <img src="https://img.shields.io/badge/NestJS-E0234E?style=flat-square&logo=NestJS&logoColor=white"/> <img src="https://img.shields.io/badge/MySQL-4479A1?style=flat-square&logo=MySQL&logoColor=white"/> <img src="https://img.shields.io/badge/MongoDB-47A248?style=flat-square&logo=MongoDB&logoColor=white"/> <img src="https://img.shields.io/badge/Redis-DC382D?style=flat-square&logo=Redis&logoColor=white"/> </div>
<div align="left"> <img src="https://img.shields.io/badge/NestJS-E0234E?style=flat-square&logo=NestJS&logoColor=white"/> <img src="https://img.shields.io/badge/MongoDB-47A248?style=flat-square&logo=MongoDB&logoColor=white"/> </div>

**Infra**

<div align="left"> <img src="https://img.shields.io/badge/Docker-2496ED?style=flat-square&logo=Docker&logoColor=white"/> <img src="https://img.shields.io/badge/Nginx-009639?style=flat-square&logo=Nginx&logoColor=white"/> <img src="https://img.shields.io/badge/GitHub_Actions-2088FF?style=flat-square&logo=GitHubActions&logoColor=white"/> <img src="https://img.shields.io/badge/NCloud-03C75A?style=flat-square&logo=Naver&logoColor=white"/> </div>

## πŸš€ ν”„λ‘œμ νŠΈ μ‹œμž‘ κ°€μ΄λ“œ
## μ‹œμŠ€ν…œ μ•„ν‚€ν…μ²˜ λ‹€μ΄μ–΄κ·Έλž¨

**Frontend**
![image](https://github.com/user-attachments/assets/ab96462b-5f38-4dd9-9c72-984829fa873d)

<details>
<summary>Frontend (μΆ”ν›„ λ³€κ²½)</summary>
## πŸš€ ν”„λ‘œμ νŠΈ μ‹œμž‘ κ°€μ΄λ“œ

```bash
# μ €μž₯μ†Œ 볡제
git clone https://github.com/boostcampwm-2024/web33-boostproject.git

# ν”„λ‘œμ νŠΈ ν΄λ”λ‘œ 이동
cd frontend

# μ˜μ‘΄μ„± μ„€μΉ˜
npm install

# 개발 μ„œλ²„ μ‹€ν–‰
npm run dev
pnpm install

# ν”„λ‘œλ•μ…˜ λΉŒλ“œ
npm run build
```

</details>

**Backend**
pnpm run build

<details>
<summary>Backend (μΆ”ν›„ λ³€κ²½)</summary>
# ν”„λ‘œμ νŠΈ 개발 λͺ¨λ“œ μ‹€ν–‰
# Frontend: http://localhost:5173/
# Backend: http://localhost:3000/
pnpm run dev

```bash
# ν”„λ‘œμ νŠΈ ν΄λ”λ‘œ 이동
cd backend

# μ˜μ‘΄μ„± μ„€μΉ˜
npm install

# 개발 μ„œλ²„ μ‹€ν–‰
npm run start:dev

# ν”„λ‘œλ•μ…˜ λΉŒλ“œ
npm run build
# ν”„λ‘œμ νŠΈ Docker λΉŒλ“œ ν›„ μ‹€ν–‰ (http://localhost/)
docker-compose up -d --build
```

</details>

## πŸ”— ν”„λ‘œμ νŠΈ 링크

| λ…Έμ…˜ | λ””μžμΈ |
Expand Down

0 comments on commit cf6bcdf

Please sign in to comment.