neukkim-good

서비스 기획 의도

이 프로젝트는 신한투자증권 프로디지털아카데미 6기 과정에서 진행된 리액트 기반 미니 프로젝트입니다. 교육생 분들이 쉬는 시간에 즐겨 하시던 사과게임을 계기로, "게임 결과를 서로 공유하고, 멀티플레이로 함께 즐길 수는 없을까?"라는 질문에서 아이디어가 시작되었습니다.

본 서비스는 사용자가 점수를 공유하고, 실시간으로 함께 플레이하며 경쟁할 수 있는 즐거운 플랫폼을 만드는 것을 목표로 합니다. 이를 통해 참여자 간의 유대감을 높이고 재미있는 경험을 제공하고자 합니다.

👋 introduce team member

이름	역할
여은동	로그인/회원가입, CI/CD
김민규	랭킹페이지, 소켓 환경 구축
정다영	사과게임 구현(싱글, 멀티)
한정우	내기페이지, 게임 결과 공지
황인찬	메인페이지, 마이페이지

---

🛠️ Tech

Frontend

Backend

Socket

Database

Infrastructure

---

React Project Build Instructions

1. Clone the Repository

   git clone https://github.com/neukkim-good/neukkim-client.git

2. Navigate to the Project Directory

   cd neukkim-client

3. Install Dependencies

   npm install

4. Create an Environment File

   NEXT_PUBLIC_API_URL=http://localhost:3001
   NEXT_PUBLIC_WS_URL=localhost:3002

5. Start the Server

   npm run dev

Express Project Build Instructions

1. Clone the Repository

   git clone https://github.com/neukkim-good/neukkim-server.git

2. Navigate to the Project Directory

   cd neukkim-server

3. Install Dependencies

   npm install

4. Create an Environment File

   PW=""

5. Start the Server

   npm run start

---

Project Introduction

Architecture

💻 demonstration video

메인 플로우: 시연영상

멀티 게임: 시연영상

✨ Screen

Title	Img
메인 스크린
싱글 플레이
멀티 플레이
랭킹 스크린
공지사항(게임 결과)
마이페이지

---

🎯 Commit Convention

• feat: Add a new feature
• fix: Bug fix
• docs: Documentation updates
• style: Code formatting, missing semicolons, cases where no code change is involved
• refactor: Code refactoring
• test: Test code, adding refactoring tests
• hore: Build task updates, package manager updates

💡 PR Convetion

아이콘	코드	설명
🎨	:art	Improving structure/format of the code
⚡️	:zap	Performance improvement
🔥	:fire	Code/file deletion
🐛	:bug	Bug fix
🚑	:ambulance	Critical fix
✨	:sparkles	New features
💄	:lipstick	Adding/updating UI/style files
⏪	:rewind	Reverting changes
🔀	:twisted_rightwards_arrows	Branch merging
💡	:bulb	Adding/updating comments
🗃	:card_file_box	Database-related modifications