Teespace-core NPM

본 저장소는 TeeSpace Core 에 대한 저장소 입니다. TeeSpace를 위한 공통 Store와 API 모듈 및 WebSocket 모듈 등을 포함하고 있습니다. TeeSpace에 들어가는 각 앱은 본 저장소를 사용하여 구현합니다.

초기 설정 (Visual Studio Code)

Visual Studio Code를 설치합니다.

VSCode 설치가 완료되었다면, 다음과 같은 Extension 을 설치 합니다.

prettier - Code formatter
ESLint
auto import

NodeJS LTS 버전과 yarn 패키지를 설치합니다.

설치가 완료되면, 다음과 같이 의존 라이브러리를 설치합니다.

$ yarn install

사용 가능한 명령어

`yarn start`

본 모듈을 개발모드로 실행합니다. 코드를 수정하면 자동으로 빌드를 시작합니다.

`yarn test`

테스트 러너를 실행합니다.

`yarn build`

본 모듈을 운영환경으로 빌드 합니다.

모듈 연동 방법 (packages.json 선언 방식)

teespace-core 저장소를 사용하고자 하는 프로젝트 내 packages.json 파일을 에디터로 엽니다. packages.json 파일에 있는 dependencies 필드에 다음과 같이 teespace-core 저장소를 추가 합니다.

"teespace-core": "git+http://git@192.168.158.12:teespace/teespace-core#develop"

teespace-core 저장소 추가가 완료 되었다면, 패키지를 다시 설치 합니다.

yarn install

모듈 연동 방법 (yarn link 방식)

본 모듈 연동 방식은 yarn link 방식으로 연동 하는 방법을 안내합니다. 앱 개발 및 플랫폼 연동을 진행할 때 개발 편의성을 위하여 사용 됩니다. 일반적인 사용을 원하신다면, packages.json 연동 방식을 참고하시기 바랍니다.

teespace-core 프로젝트 설정

1. 본 저장소를 clone 받습니다.

    $ git clone git@192.168.158.12:teespace/teespace-core.git

2. clone 받은 디렉토리로 이동합니다
    $ cd teespace-core

3. 패키지를 설치합니다
    $ yarn install

4. 본 모듈을 다른 프로젝트에서 사용할 수 있도록 global link 를 등록합니다
    $ yarn link

5. (추가) 릴리즈되지 않은 최신 코드로 테스트 하고 싶은 경우
    $ yarn start
    위 명령어를 사용하면 최신 코드로 빌드하며, 코드 수정 시 바로 반영 됩니다

teespace 또는 app 에서 teespace-core 모듈 연동 방법

1. teespace-core를 사용하기 위한 프로젝트로 이동
    $ cd teespace-platform

2. teespace-core를 등록
    $ yarn link teespace-core

3. 위 과정까지 거치면 다음과 같이 teespace-platform(예시) 에서 사용할 수 있습니다
    import { useCoreStores } from 'teespace-core'

4. (추가)packages.json 에 dependencies 필드에 다음과 같이 저장소 등록이 되어 있는지 확인이 필요합니다
    "teespace-core": "git+http://git@192.168.158.12:teespace/teespace-core#develop"

모듈 업그레이드 방법

본 저장소는 지속적으로 develop 브랜치에서 업데이트가 진행되고 있습니다. 새로운 버전의 코드를 받아오길 원한다면 다음과 같이 모듈 업그레이드를 진행 해주세요

yarn upgrade teespace-core

기여 방법

git commit 메세지 컨벤션

git commit 메세지 컨벤션은 본 문서를 기반으로 작성되었습니다.

커밋 메세지는 타입(모듈): 설명 형태로 작성이 됩니다. 커밋할 때 자동으로 형식을 검사합니다. 유효하지 않은 형태로 커밋 메세지 작성 시 정상적으로 커밋이 되지 않습니다. 각 타입에 대한 설명은 다음과 같습니다.

타입	설명
feat	기능 추가, 라이브러리 추가, API 변경 시 사용
refactor	코드 구조 변경 시 사용
fix	버그 수정 시 사용
docs	문서 수정 시 사용
test	테스트 코드 작성 시 사용
chore	자잘한 수정이 있을 시 사용 (예. 설정 파일 변경 등)

코드 수정하여 다른 코드에 영향을 줄 수 있는 것은 BREAKING CHANGE 를 사용하여 작성합니다. 이에 대한 설명은 다음과 같습니다.

feat(common): TeeSpace를 위한 API 클래스 구현

BREAKING CHANGE: axios를 직접 사용하지 않고, API 클래스를 사용하여 구현 필요

Merge Request

작성 예정

Code Review

작성 예정

주의

깨진 코드 (빌드 되지 않거나 동작하지 않는 코드)를 develop 브랜치에 머지 되면 안됩니다.
pull 받으실 때는 꼭 rebase pull 을 사용하세요. (git pull --rebase origin)
develop 브랜치에서 기능 브랜치를 생성하는 경우, 주기적으로 develop 브랜치를 rebase 하여 충돌을 최소화 해주세요. (git rebase develop)
가급적 merge commit은 자제하여 깨끗한 커밋 로그를 남길 수 있도록 합니다.

API Reference

API 모듈

API
- ~~Get(url, params) ⇒ Promise ⏏~~
- ~~Post(url, params, config) ⇒ Promise ⏏~~
- ~~Put(url, params, config) ⇒ Promise ⏏~~
- ~~Delete(url, params) ⇒ Promise ⏏~~
- get(url, params) ⇒ Promise ⏏
- post(url, params, config) ⇒ Promise ⏏
- put(url, params, config) ⇒ Promise ⏏
- delete(url, params) ⇒ Promise ⏏