toss-pos-plugin-template

Toss POS 플러그인 개발을 위한 공식 템플릿 저장소입니다. (🔗 Toss POS SDK 연동 - 공식 홈페이지)

toss-pos-plugin-template 저장소는 Toss POS 환경에서 실행되는 플러그인을 빠르고 효율적으로 구현할 수 있도록 돕는 프로젝트 템플릿을 제공합니다.

1. 개요

템플릿들은 개발자가 Toss POS 내에서 다양한 비즈니스 로직 및 페이지 내의 UI 기능을 플러그인 형태로 구현할 수 있도록 설계되었습니다. 각 템플릿은 특정 실행 환경(Worker 또는 Iframe) 및 언어(JavaScript 또는 TypeScript)에 최적화되어 있습니다.

2. 템플릿 목록

toss-pos-plugin-template 저장소는 플러그인 실행 방식과 개발 언어에 따라 각 템플릿 폴더로 나뉘어 있습니다:

템플릿 폴더 이름	실행 방식	사용 언어	주요 용도
worker-plugin-ts	Worker (백그라운드)	TypeScript	백그라운드 작업과 타입 안정성이 필요한 플러그인 개발
worker-plugin-js	Worker (백그라운드)	JavaScript	백그라운드 작업 및 비동기 처리가 필요한 플러그인 개발
iframe-plugin-ts	iFrame (UI 포함)	TypeScript	UI와 타입 안정성이 필요한 플러그인 개발
iframe-plugin-js	iFrame (UI 포함)	JavaScript	사용자 인터페이스(UI)가 필요한 플러그인 개발

3. 시작하기

각 템플릿은 독립적인 구조를 가지고 있으며, 시작, 설정, 테스트에 필요한 상세 지침을 포함하고 있습니다.

사용법 및 상세 구현 가이드는 해당 폴더 내의 README.md 파일을 참조해 주세요.

• worker-plugin-ts
• worker-plugin-js
• iframe-plugin-ts
• iframe-plugin-js

사용 전제 조건

• Node.js와 npm과 같은 패키지 매니저가 시스템에 설치되어 있어야 합니다.

일반적인 사용 절차

1. 원하는 템플릿 폴더를 선택하여 복사하거나 클론합니다.
2. 선택한 폴더 내부로 이동합니다.
3. 폴더 내의 README.md에 명시된 대로 의존성 설치 및 빌드 작업을 진행합니다.
4. 토스 POS 환경에서 플러그인을 테스트하고 실행합니다. (🔗 토스플레이스 연동 가이드 참고)

4. 기여

이 템플릿 저장소에 대한 제안이나 개선 사항은 언제든지 환영합니다.

Issue 또는 Pull Request를 통해 기여할 수 있습니다.