@newbiz/admin-script-libs

Admin Script Libs

신사업 프론트엔드 공통 어드민 셋업 라이브러리.

This project was generated by Vessel. For a simple and quick reference, click here.

About

신사업 프론트엔드에서 제작하는 BackOffice 어드민 셋업을 위한 스크립트 라이브러리.
로컬환경에서 해당 라이브러리의 모듈을 실행하여, 어드민 공통 설정이나 디펜던시에 관련된 내용을 초기 셋업해주기 위한 용도.

Installation

해당 모듈을 사용할 프로젝트에서는 아래와 같이 dev-dependency로 설치한다.

$ npm install --save-dev @newbiz/admin-script-libs
or
$ yarn add --dev @newbiz/admin-script-libs

Usage

아래와 같이 package.json에서 npm install 후 실행되도록 한다.

{
  "script": {
    "postinstall": "admin-script"
  }
}
...

npm install 커맨드 실행시 디펜던시 설치가 완료되면 admin-script가 수행되며, 이 때 내부 템플릿의 설정 파일이 복사되어 관련 파일이 모두 overwrite 되므로 주의한다. 또한 package.json 파일내 필요 항목이 누락되어 있다면 추가되어 수정이 일어나게 된다.

admin-script가 수행되면 이후에는 필요에 따라 .gitignore에 기재된 파일을 제외하고 수정하여 레파지토리에 반영하면 된다.

Admin Project Settings

.gitignore

각 어드민 프로젝트에서, 개발환경 공통설정 관련 항목들을 레파지토리에 반영하지 않도록(dev/pre/live 등에서 불필요한 파일) 하기 위해 아래 내용을 미리 설정해둔다.

...

# Ignored by admin-script
.editorconfig
.eslintignore
.eslintrc.js
jest.config.js
webpack.config.js

Change Log

해당 프로젝트의 CHANGELOG.md 파일 참조.

License

해당 프로젝트의 LICENSE 파일 참조.