CONTRIBUTION.md

CONTRIBUTION

'낸내' 프로젝트에 기여해주셔서 감사합니다.

설치하기

# 시작하기 전, 먼저 프로젝트를 자신의 리포지토리에 포크해주세요.

git clone https://github.com/<GitHub User name>/naen-nae
cd naen-nae

yarn # 디펜던시 설치
yarn dev # 앱 구동 (http://localhost:3000/)
yarn build # 앱 빌드

낸내는 Vite-SSG를 이용해 앱을 빌드하고 있으며, 최신 버전의 NodeJS를 사용해주세요.

프로젝트 구조

다음과 같이 프로젝트를 관리하고 있습니다.

• public/
  • sw.js: 폰트 캐싱을 위한 서비스 워커 스크립트
• src/
  • components/: 컴포넌트 소스 코드 디렉터리
  • composables/: Vue 3 Composables 소스 코드 디렉터리
  • pages/: 페이지 소스 코드 디렉터리
  • store/: 상태 관리 모듈인 Pinia의 소스 코드 디렉터리
  • stories/: Storybook 소스 코드 디렉터리
  • styles/: 스타일(Sass) 소스 코드 디렉터리
  • auto-imports.d.ts: unplugin-auto-import 플러그인을 통해 자동으로 생성되는 vue, vue-router, @vueuse, pinia 타입 정의 파일
• vite.config.ts: Vite 번들러 설정 스크립트
• windi.config.ts: CSS 프레임워크인 WindiCSS 설정 스크립트

폰트 파일

폰트 파일은 fonts 리포지터리로 분리해 관리하고 있습니다.