cell-design-system

Cell

설명

강남언니의 모바일 웹, 웹뷰에 적용되는 디자인 시스템입니다.

👉 Cell Guide

Stack

• vue
• jest
• vuepress

개발 환경 셋팅

# Project setup
npm install

# Compiles and hot-reloads for development
npm run dev

프로젝트 배포 방법

• npm 배포와 document site 배포
  • origin/main branch에 push하면 github action을 통해 npm과 document site(vuepress) 배포를 자동으로 진행합니다.
  • ⚠️ Warning ⚠️ main에 push 할때 package version을 업데이트 해주세요. npm 배포를 위해서는 version 업데이트가 필수입니다.

• Vuepress(Docs) 빌드

  npm run docs:build

프로젝트 내 Cell 사용 방법

1. 아래 명령어로 npm에서 cell-design-system을 설치합니다.

   npm install cell-design-system

   
   
2. Vue 프로젝트 내에서 Plugin으로 설치합니다.

   import Cell from 'cell-design-system'
   
   Vue.plugin(Cell)

문서 작성 방법

• Task 생성 및 관리
  현재 Cell 프로젝트의 모든 Task는 Project 보드에서 관리하고 있습니다. 새 Task는 Project 보드에서 + 버튼을 클릭하여 생성하거나 Issues에 등록했던 것을 Task로 등록합니다.

• 회의록 작성 및 관리
  모든 회의록은 Issues 메뉴에서 관리합니다.
  • 등록 방법: New Issue 버튼을 클릭하여 Issue를 생성하고, Label은 Meeting, Projects는 해당하는 프로젝트로 설정합니다.
  • 회의록 목록

• 컴포넌트 문서 생성
  1. docs/components 폴더 아래 c-[엘리먼트/컴포넌트명].md 파일을 생성합니다.
  2. docs/.vuepress/components/examples 폴더 아래 c-[엘리먼트/컴포넌트명]-doc.vue 파일을 생성합니다.

각 폴더 설명

추후 작성 예정

Test Code 작성법

추후 작성 예정