Skip to content

codeit-fe-14-project2-team5/Wikid

Repository files navigation

💻 Wikid

"이 프로젝트는 지인들의 위키를 직접 작성하고 공유하는 플랫폼입니다."


👤 팀원 소개 & 역할

이름 GitHub 주요 담당 기능 프로필
강희정 @tansxx 내 위키 페이지, 프로젝트 기초 세팅, 깃 리드미 작성, 배포
박하은 @prkhaeun 랜딩, 공통 컴포넌트, 모달 UX, 발표
손혁진 @sssson0 회원 인증 (가입/로그인), 계정 설정
이윤승 @ShiroUsagi25 게시글 상세 UI, 게시글 작성
전수영 @daonJeon 위키 목록 페이지, 자유게시판

🔗 배포 주소

🚀 배포 환경

  • vercel

🗓 개발 기간

  • 2025.04.22 ~ 2025.05.08

✨ 주요 기능 요약


⚙️ 설치 및 실행 방법

# 1. 저장소 클론
$ git clone [저장소 URL]
$ cd [프로젝트 디렉토리]

# 2. 의존성 설치
$ npm install

# 3. 개발 서버 실행
$ npm run dev

🛠 Tech Stack

역할 사용 기술
Language React JavaScript TypeScript
Framework Next.js
Router ReactRouter
Styling StyledComponents
API Axios
Auth NextAuth

본 프로젝트는 아래 기술 스택을 기반으로 구성되었습니다.

🔧 Environment & Build

Next.js Webpack Vercel

🎨 UI & Styling

React TypeScript StyledComponents Tailwind CSS

🔌 API & Auth

Axios

🔁 Routing & State

React Router


📂 폴더 및 파일 구조 (Folder Structure)

wikid
│
├── .github          # Github 설정
│
├── public/          # 정적 파일들을 저장
│    └── assets/     # 이미지, 아이콘 등 저장
│         ├── icons/
│         └── images/
│
├── src/
│    ├── apis/
│    │
│    ├── components/ # 재사용 가능한 UI 컴포넌트
│    │
│    ├── costants/   # 상수 값 관리
│    │
│    ├── contexts/   # React Context API 관련 파일
│    │
│    ├── hooks/      # 커스텀 훅
│    │
│    ├── pages/      # 라우트 단위 페이지 컴포넌트
│    │
│    ├── styles/     # 공통 GlolbalStyle & Theme 관리
│    │
│    └── utils/      # 유틸리티 함수 모음
│
📄 .eslintrc.json        # ESLint 설정
📄 .gitignore            # Git에서 무시할 파일 목록
📄 next.config.js        # Next.js 설정
📄 package.json          # 프로젝트 설정 및 의존성
📄 tsconfig.json         # TypeScript 설정
📄 README.md             # 프로젝트 설명 문서

🧾 네이밍 규칙

항목 방식 예시
폴더명 kebab-case user-profile
컴포넌트 PascalCase WikiCard.tsx
스타일 파일 kebab-case + .styles.js wiki-section.styles.js
이미지 kebab-case logo-icon.png
변수/함수 camelCase fetchWikiData
환경변수 UPPER_SNAKE_CASE NEXT_PUBLIC_API_URL


🌿 Git Branch 전략

브랜치명 목적
main 배포 전용 브랜치
develop 통합 개발 브랜치
feature/* 기능 개발 단위 브랜치
fix/* 버그 수정 브랜치
docs/* 문서 관련 브랜치

💬 커밋 메시지 컨벤션

태그 의미
Feat ✨ 기능 추가
Fix 🐛 버그 수정
Style 💄 스타일 변경
Docs 📝 문서 변경
Refactor 🔨 리팩토링
Test ✅ 테스트 코드
Chore 🔧 기타 설정 변경

예시

✨ Feat: 위키 카드 컴포넌트 생성
- 사용자 이미지 및 소개 텍스트 구현
- 반응형 레이아웃 처리 완료

🌈 이모지 가이드

이모지 의미
🎨 코드 형식/구조 개선
📰 새 파일 추가
새로운 기능
📝 사소한 변경
💄 UI / 스타일 수정
🐎 성능 개선
📚 문서 수정
🐛 버그 수정
🚑 핫픽스
🔥 코드 삭제
🚜 구조 변경
🔨 리팩토링
💎 새 릴리즈
🔖 버전 태그
🚀 배포

About

코드잇 중급 프로젝트 Wikid

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5