Quick Start
- 시작하기
- 엔트리 하드웨어 개발 튜토리얼
Basic
- 개발 환경 세팅
- PR 요청하기
- 자주 하는 질문
- 자주 발생하는 에러
Entry JS
- 시작하기
- 블록 명세 작성
- 블록 사용 등록
- 블록 모양별 개발 방법
- 하드웨어 블록 만들기
- 하드웨어 블록 번역작업
- 하드웨어 블록 추가하기
- 프로젝트 테스트하기
Entry HW
- 시작하기
- 하드웨어 모듈 추가하기
- 블루투스 하드웨어 추가하기
- 하드웨어 연결 테스트하기
- 하드웨어 등록 서비스 신청하기
Entry Offline
- 시작하기
- 프로젝트 구조
- 개발하기
- 오브젝트 추가하기
- 다국어 작업하기
- 커스텀 프로젝트 빌드
- 빌드하기
Etc.
- Git 사용 방법
- 문서 기여하기
- 문서 업데이트 내역
개발 환경 세팅
NOTICE! 개발 중 문제가 발생하면 자주 발생하는 오류 페이지를 참고해 주시기 바랍니다.
Git 설치 및 GitHub 회원 가입
Git 설치
연관 페이지: Git 사용 방법
엔트리의 오픈소스 프로젝트는 Git을 사용하여 관리합니다. Git을 사용하여 코드를 기록하고 오픈소스에 반영하므로 반드시 Git을 설치해야 합니다.
- macOS, Windows 사용자는 Git - Downloads에서 Git 설치 파일을 다운로드하여 실행합니다.
- Linux 사용자는 Git - Git 설치를 참고하여 Git을 설치합니다.
GitHub 회원 가입
GitHub은 Git을 사용해 관리할 수 있는 원격 저장소입니다.
엔트리 프로젝트 또한 GitHub에 저장소가 있습니다.
다음과 같은 정보를 입력하여 쉽게 GitHub에 회원 가입할 수 있습니다.
Node.js, Node-gyp 개발 환경 설정
Node.js 설치
Node.js를 설치하려면 Node.js에서 설치 파일을 다운로드하여 실행합니다.
현재 엔트리 개발팀은 16.19.0 버전을 사용 중입니다(2022.05.25 기준). 최소 14이상의 버전 사용을 추천드립니다.
Node.js를 설치하면 npm이 함께 설치됩니다.
npm을 이용하여 라이브러리를 설치하고 관리할 수 있습니다.
설치가 완료되면 명령 프롬프트 창에서 다음 명령어를 입력해 정상적으로 설치되었는지 확인합니다.
npm --version |
정상적으로 설치되었다면 다음과 같은 결과가 출력됩니다. 버전은 다를 수 있습니다.
윈도우 OS에서 Node.js를 설치했지만 node 명령어 사용이 되지 않는다면 환경변수를 확인해 주시기 바랍니다.
Yarn 설치
엔트리 팀은 패키지 매니저로 yarn 을 사용합니다. 그러므로 yarn 을 통해 의존성 관리를 하는 것을 추천드립니다.
yarn 설치가 필수사항은 아니지만, 패키지의 세부버전들이 yarn.lock에 맞추어져 있습니다. npm을 그대로 사용하실 경우 package-lock.json을 제거하시고 사용하시는 것을 추천드립니다.
yarn 을 설치한 경우, npm install
및 npm run
명령어는 yarn
으로 대체됩니다.
(npm install -> yarn
, npm run start -> yarn start
)
npm install --global yarn |
Node-gyp 설치
엔트리 하드웨어는 시리얼포트 통신을 위해 node-serialport 라이브러리를 사용합니다.
해당 라이브러리를 사용하기 위해서는 C++, python 빌드 환경과 node-gyp 라이브러리가 필요합니다.
빌드에 대한 자세한 사항은 node-gyp ReadMe와 자주 발생하는 에러 을 참고해 주세요.
윈도우의 경우는 아래 방법중 1가지로 window build tools를 설치해 주세요. 엔트리팀은 2017버전(15.9.50)을 사용중입니다.
- visual studio installer를 사용해서 visual studio와 함께 설치 설치(추천)
- chocolatey를 사용해서 설치
npm을 사용해서 설치(2023.05.25일 기준으로, npm에 등록된 window build tools 이미지에 문제가 있어 정상 동작하지 않습니다.)
그 다음 빌드 라이브러리인 node-gyp 을 설치해주세요.
yarn global add node-gyp |
엔트리 프로젝트 설치
원격 저장소의 데이터를 자신의 원격 저장소에 복사
엔트리 하드웨어 개발에는 다음과 같은 엔트리 프로젝트가 필요합니다.
- Entry Js: 엔트리 워크스페이스와 블록을 개발할 수 있는 라이브러리
- Entry Hardware: 엔트리에 아두이노 등 여러 하드웨어를 연결할 수 있도록 도와주는 프로그램
엔트리 하드웨어 개발은 두 개의 프로젝트를 자신의 원격 저장소에 그대로 복사(fork)하여 작업한 후 작업 내역을 합병 요청하는 방식으로 이루어집니다.
두 저장소에 접속한 후 오른쪽 위의 Fork를 클릭하여 자신의 원격 저장소로 복사합니다.
자신의 원격 저장소 데이터를 자신의 컴퓨터로 복사
다음 명령어를 실행하여 자신의 원격 저장소 데이터를 자신의 컴퓨터로 복사(clone)합니다. 이 명령은 명령 프롬프트 또는 Git Bash에서 실행할 수 있습니다.
git clone https://github.com/[사용자명]/entry-hw.git |
브랜치 변경
하드웨어 블록을 개발하는 경우 develop-hw
라는 브랜치를 사용해야 합니다.
develop-hw 브랜치는 하드웨어 관련 PR 이 모여서, 배포전에 develop 에 merge 되는 용도로 사용 중입니다.
(develop 브랜치는 엔트리 개발팀에서 이슈 처리를 하는 브랜치 입니다.)
Git은 작업 내역을 분할/관리하기 위해 브랜치라는 개념을 사용합니다.
자세한 설명은 Git - 브랜치란 무엇인가?를 참고하세요.
각 프로젝트의 디렉토리에서 다음 명령어를 실행하여 develop-hw 브랜치를 사용하게 설정합니다.
git checkout develop-hw |
브랜치를 변경하면 다음과 같은 결과가 출력됩니다.
결론적으로는,
entryjs, entry-hw 모두 develop-hw 브랜치에서 작업하시면 됩니다.
의존성 라이브러리 설치하기
엔트리 프로젝트를 실행하려면 추가 라이브러리가 필요합니다. npm을 이용하여 필요한 라이브러리를 설치할 수 있습니다.
entryjs 디렉터리에서 다음 명령어를 실행합니다.
yarn |
entry-hw 디렉터리에서 다음 명령어를 실행합니다.
yarn |
각 명령어를 실행하면 다음과 같은 화면이 출력됩니다.
실행해서 정상 설치 확인하기
마지막으로 각 프로젝트를 실행해서 정상적으로 설치 되었는지 확인합니다.
entryjs 디렉터리에서 다음 명령어를 실행합니다.
yarn serve |
entry-hw 디렉터리에서 다음 명령어를 실행합니다.
yarn start |
각 명령어를 실행하면 다음과 같은 화면이 출력됩니다.