Machbase Neo JSH runtime에서 동작하는 간단한 예제 패키지입니다. demo 엔트리 포인트를 통해 CLI 명령을 실행하고, HTTP 서버 실행과 Mach CLI 조회 같은 기본 예제를 빠르게 확인할 수 있습니다.
JSH에서 아래 명령으로 demo를 설치합니다.
pkg install -g github.com/machbase/neo-demodemo hello [name]: 간단한 인사 출력demo argv [value]: 전달된 인자 확인demo server --port <port>: 예제 HTTP 서버 실행/,/greeting,/system,/todo엔드포인트를 확인할 수 있습니다.
demo server-install --port <port>: 서버 스크립트를 서비스로 등록demo machcli-query: Machbase 조회 예제 실행demo mustache [options]: npm package dependency 로 설치한 Mustache를 JSH에서 불러와 렌더링하는 예제demo readline [--auto <text>]:readline입력 예제 실행
demo mustache 는 이 저장소에서 외부 npm dependency 사용 가능 여부를 확인하기 위한 데모로,
pkg install 로 설치된 npm dependency 가 JSH 런타임에서 실제로 require('mustache') 되어 동작하는지 확인하는 용도입니다.
이 저장소는 데모 실행 재현성을 위해 package-lock.json 을 함께 관리합니다. npm dependency 버전을 고정해 환경별 설치 차이로 예제가 달라지거나 깨지는 일을 줄이기 위한 목적입니다.
다른 JSH 패키지를 작성할 때도 같은 기준으로 판단할 수 있습니다.
- 데모, 튜토리얼, CLI, 서버처럼 실행 결과를 그대로 재현하는 것이 중요한 패키지는
package-lock.json을 저장소에 포함하는 편이 좋습니다. - 여러 개발자가 같은 예제를 따라 하거나 문서의 실행 결과를 검증해야 한다면 lockfile 공유가 기본값에 가깝습니다.
- 반대로 다른 애플리케이션이 가져다 쓰는 범용 라이브러리 패키지라면
package-lock.json을 꼭 배포 기준으로 삼을 필요는 없고, 의존성 범위를 어떻게 열어둘지 정책을 먼저 정하는 편이 낫습니다. - 어느 경우든
node_modules/는 저장소에 포함하지 않고, lockfile 을 포함할지 제외할지만 별도로 결정하면 됩니다.
machbase-neo jsh main.js hello Neo
machbase-neo jsh main.js argv sample
machbase-neo jsh main.js server --port 7575
machbase-neo jsh main.js mustache --name Neo --topic "npm package demo"
machbase-neo jsh main.js readline --auto "hello neo"서버를 실행한 뒤 브라우저에서 http://127.0.0.1:7575/ 로 접속하면 엔드포인트 목록 페이지를 볼 수 있고, http://127.0.0.1:7575/todo 에서는 Mustache 템플릿으로 렌더링되는 간단한 웹 TODO 예제를 확인할 수 있습니다.
main.js: 명령 라우팅 엔트리 포인트demos/hello/index.js: 기본 인사 출력 예제demos/argv/index.js: argv 확인 예제demos/server/index.js: HTTP API 예제demos/server/home.mustache.html:/엔드포인트 템플릿demos/server/todo.mustache.html:/todo엔드포인트 템플릿demos/server/install.js: 서비스 설치 예제demos/machcli/query.js: Mach CLI 조회 예제demos/machcli/machcli.json: Mach CLI 연결 설정 예제demos/mustache/index.js: npm dependency Mustache 렌더링 예제demos/readline/index.js: readline 입력 예제
데모 수가 늘어날 때 파일 관리가 직관적이도록 각 예제는 demos/<demo-name>/ 아래에 관련 스크립트와 설정, 템플릿 파일을 함께 둡니다. 예를 들어 서버 데모는 실행 스크립트와 설치 스크립트, HTML 템플릿을 모두 demos/server/ 아래에서 관리합니다.