sdk-codegen

(★ 272)

One SDK to rule them all, and in the codegen bind them

  • .editorconfig
  • .envrc
  • .eslintignore
  • .gitignore
  • .prettierignore
  • .prettierrc.js
  • .python-version
  • .release-please-manifest.json
  • babel.common.js
  • babel.config.js
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • env-sample
  • examplesIndex.json
  • jest.config.js
  • jest.setup.js
  • lerna.json
  • LICENSE
  • looker-sample.ini
  • package.json
  • Pipfile
  • Pipfile.lock
  • README.md
  • release-please-config.json
  • release-please-config.json.template
  • shell.nix
  • tsconfig.build.json
  • tsconfig.common.json
  • tsconfig.json
  • webpack.base.config.js
  • webpack.browser.config.js
  • yarn.lock

# 설치 가이드

1. 코드 내려받기
git clone https://github.com/looker-open-source/sdk-codegen

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd sdk-codegen

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. .NET

보통 추천
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • .NET SDK dotnet 명령어를 쓰기 위한 SDK입니다.
cd csharp

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

dotnet restore

프로젝트에 필요한 패키지를 내려받습니다.

dotnet run

프로젝트를 빌드하고 바로 실행합니다.

dotnet run 실행 후 터미널에 나타나는 안내 메시지나 주소를 확인하세요.

3. Gradle (Java/Kotlin)

보통
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • JDK (Java) Java/Kotlin 프로젝트를 빌드/실행하려면 필요합니다.
  • Gradle 레포에 포함된 gradlew(Gradle Wrapper)를 쓰면 Gradle을 따로 설치할 필요가 없습니다.
cd kotlin

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

./gradlew build

Gradle로 빌드를 진행합니다.

BUILD SUCCESSFUL 메시지가 뜨면 성공입니다. build/ 폴더에 결과물이 생성됩니다.

4. Node.js

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.
yarn install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

yarn build

배포용으로 코드를 최적화해서 빌드 파일을 생성합니다.

yarn gen

이 명령어를 터미널에 그대로 입력해 실행하세요.

yarn wipe && yarn gen

이 명령어를 터미널에 그대로 입력해 실행하세요.

- use `yarn legacy` to call the OpenAPI generator. This will use the OpenAPI

이 명령어를 터미널에 그대로 입력해 실행하세요.

명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

5. Python

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Python 3 설치 시 'Add Python to PATH' 옵션을 꼭 체크하세요 (Windows).
pipenv install

이 명령어를 터미널에 그대로 입력해 실행하세요.

jupyter notebook

브라우저에서 노트북(.ipynb) 파일들을 열람하고 실행할 수 있는 Jupyter 화면을 켭니다.

에러 메시지 없이 실행되고 터미널에 안내 문구가 출력되면 정상입니다.

6. Go

보통
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Go Go 언어 컴파일러 및 도구 모음입니다.
cd go

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

go build ./...

Go 프로그램을 컴파일해 실행 파일을 만듭니다.

go run .

따로 빌드하지 않고 바로 Go 프로그램을 실행합니다.

빌드가 에러 없이 끝나면 성공입니다. go run . 을 썼다면 터미널 출력을 확인하세요.
// repository documentation