Skip to content

Commit

Permalink
Merge pull request #71 from urdego/feature/#70-readme-first-mvp
Browse files Browse the repository at this point in the history
Feat/#70: 1์ฐจ MVP README ์ž‘์„ฑ ์™„๋ฃŒ
  • Loading branch information
aaahyesu authored Jan 20, 2025
2 parents 7bf48d8 + be891f9 commit 1f10f4c
Showing 1 changed file with 62 additions and 23 deletions.
85 changes: 62 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,75 @@
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
# ๐Ÿ—บ๏ธ ์–ด๋ฐ๊ณ ?! - ์œ„์น˜ ์ถ”์  ๊ฒŒ์ž„ ์„œ๋น„์Šค

## Getting Started
<div align=center>

First, run the development server:
<img src="https://github.com/user-attachments/assets/38306637-e5db-4335-93a5-82469e8d236e" width="300"><br/>
<br/><strong> ์†Œ์ค‘ํ•œ ์‚ฌ๋žŒ๋“ค๊ณผ ๋– ๋‚˜๋Š” ์ถ”์–ต ์—ฌํ–‰ ๐Ÿงณ</strong><Br/>
<strong>'์–ด๋ฐ๊ณ ?!โ€™</strong>๋Š” ์‚ฌ์šฉ์ž๊ฐ€ ์ถ”์ฒœํ•˜๊ฑฐ๋‚˜ ์†Œ์ค‘ํ•œ ์ถ”์–ต์ด ๋‹ด๊ธด ์žฅ์†Œ๋ฅผ ๊ณต์œ ํ•˜๊ณ , ๊ฐ€์กฑ, ์นœ๊ตฌ๋“ค๊ณผ ํ•จ๊ป˜ ๊ทธ ์žฅ์†Œ๋ฅผ ์ฐพ๋Š” ์žฌ๋ฏธ๋ฅผ ์ œ๊ณตํ•˜๋Š” ์„œ๋น„์Šค์ž…๋‹ˆ๋‹ค. <br>์ง€์ธ๋“ค๊ณผ ์˜๋ฏธ ์žˆ๋Š” ์žฅ์†Œ๋ฅผ ์†Œ์žฌ๋กœ ์ด์•ผ๊ธฐ๋ฅผ ๋‚˜๋ˆ„๋ฉฐ ์ถ”์–ต์„ ๊ณต์œ ํ•˜๊ณ  ์ƒˆ๋กœ์šด ๊ฒฝํ—˜์„ ์Œ“์„ ์ˆ˜ ์žˆ๋Š” ํŠน๋ณ„ํ•œ ์ฆ๊ฑฐ์›€์„ ๊ฒฝํ—˜ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. <br> ์ด ์„œ๋น„์Šค๋ฅผ ํ†ตํ•ด ๋ฐ”์œ ์ผ์ƒ ์†์—์„œ๋„ ํ•จ๊ป˜ํ–ˆ๋˜ ์†Œ์†Œํ•œ ์ˆœ๊ฐ„๋“ค์„ ๋– ์˜ฌ๋ฆฌ๋ฉฐ ์†Œ์ค‘ํ•œ ์‚ฌ๋žŒ๋“ค๊ณผ ๋”ฐ๋œปํ•œ ์ถ”์–ต์„ ์ƒˆ๋กญ๊ฒŒ ๋งŒ๋“ค์–ด ๊ฐ€์„ธ์š”!<br><br>
<a href="https://urdego.vercel.app/">์–ด๋ฐ๊ณ ?! ์„œ๋น„์Šค ๋ฐ”๋กœ๊ฐ€๊ธฐ</a><Br/><Br/>
</div>

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
## โœจ ๋ฉค๋ฒ„ ์†Œ๊ฐœ

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
<div align="center">

| <img src="https://github.com/bluedog129.png" width="150" > | <img src="https://github.com/aaahyesu.png" width="150" > | <img src="https://github.com/minjeongss.png" width="150" > |
| :--------------------------------------------: | :------------------------------------------: | :--------------------------------------------: |
| [์ตœํšจ์ข…](https://github.com/bluedog129) | [๊น€ํ˜œ์ˆ˜](https://github.com/kod0751) | [๊น€๋ฏผ์ •](https://github.com/minjeongss) |
| PM, User-Service, Notification-Service | ํŒ€์žฅ, Game-Service | Content-Service, User-Service |

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
</div>

This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
## ๐Ÿ“… ํ”„๋กœ์ ํŠธ ์ง„ํ–‰ ๊ณผ์ •

## Learn More
- **๊ธฐํš๊ธฐ๊ฐ„** : 2024.10.21 ~ 2024.11.18
- **๊ฐœ๋ฐœ๊ธฐ๊ฐ„** : 2024.11.19 ~ 2024.12.09

To learn more about Next.js, take a look at the following resources:
## ๐Ÿ›  ๊ธฐ์ˆ  ์Šคํƒ

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
### ๐Ÿ’ฌ ์‚ฌ์šฉ ์–ธ์–ด

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)

## Deploy on Vercel
### ๐Ÿ“š ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ ๋ฐ ํ”„๋ ˆ์ž„์›Œํฌ

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
![React](https://img.shields.io/badge/React-61DAFB?style=for-the-badge&logo=react&logoColor=white)
![Next.js](https://img.shields.io/badge/Next.js-000000?style=for-the-badge&logo=next.js&logoColor=white)
![Styled-Components](https://img.shields.io/badge/Styled_Components-DB7093?style=for-the-badge&logo=styled-components&logoColor=white)

### ๐Ÿ“ก ์™ธ๋ถ€ API ๋ฐ ํ†ต์‹  ๊ธฐ์ˆ 

![WebSocket](https://img.shields.io/badge/WebSocket-000000?style=for-the-badge&logo=websocket&logoColor=white)
![STOMP](https://img.shields.io/badge/STOMP-009688?style=for-the-badge&logo=stomp&logoColor=white)
![Google Maps](https://img.shields.io/badge/Google_Maps-4285F4?style=for-the-badge&logo=google-maps&logoColor=white)
![Google Cloud Vision](https://img.shields.io/badge/Google_Cloud_Vision-4285F4?style=for-the-badge&logo=google-cloud&logoColor=white)

### ๐Ÿ”— Dependency

![Storybook](https://img.shields.io/badge/Storybook-FF4785?style=for-the-badge&logo=storybook&logoColor=white)
![React Zustand](https://img.shields.io/badge/Zustand-000000?style=for-the-badge&logo=react&logoColor=white)
![Axios](https://img.shields.io/badge/Axios-5A29E4?style=for-the-badge&logo=axios&logoColor=white)

### Architecture

<img src="https://github.com/user-attachments/assets/72a93272-8abe-44d0-b9e4-14d609321154" width="800">

## ๐ŸŽฏ ๊ธฐ๋Šฅ ์†Œ๊ฐœ

| ์ปจํ…์ธ  ์—…๋กœ๋“œ | ์ปจํ…์ธ  ์กฐํšŒ |
| :-----------: | :---------: |
| ![ppt](https://github.com/user-attachments/assets/1c21460c-fef2-4355-9166-f23026880a69)| ![image](https://github.com/user-attachments/assets/92f6db29-93bd-4878-a731-87998c47bb67) |


| ์นœ๊ตฌ ์ดˆ๋Œ€ | ๋Œ€๊ธฐ๋ฐฉ |
| :-------: | :----: |
| ![image](https://github.com/user-attachments/assets/e3747f88-687f-4275-b8e5-384f49beebc7) | ![image](https://github.com/user-attachments/assets/caacfdec-9429-4686-b6d3-fb9f24a8c7b0) |

| ๊ฒŒ์ž„ ์‹œ์ž‘ | ๋ฌธ์ œ ์ถœ์ œ |
| :-------: | :-------: |
| ![image](https://github.com/user-attachments/assets/0ef508c5-fdfb-4c1f-b2da-ccf3b1f345c0) | ![image](https://github.com/user-attachments/assets/448292d3-4124-4002-822a-12ceb08ec2fc) |


| ๋‹ต์•ˆ ์ œ์ถœ | ๊ฒฐ๊ณผ ๋ฐ˜ํ™˜ |
| :-------: | :-------: |
| ![a7364026b0640d79](https://github.com/user-attachments/assets/345804da-a8bd-44e6-9cf8-9f8cfa71265f) | ![7209d730e9e4e594](https://github.com/user-attachments/assets/3b51a2de-272e-4561-b12f-07fc6bdeba0b) |

Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.

0 comments on commit 1f10f4c

Please sign in to comment.