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

# Installation Guide

1. Get the code
git clone https://github.com/looker-open-source/sdk-codegen

Downloads the entire project code from GitHub to your computer.

cd sdk-codegen

Moves into the project folder you just downloaded.

2. .NET

Medium Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • .NET SDK The SDK required for the dotnet command.
cd csharp

This project's files live in a subfolder, so move into it first.

dotnet restore

Downloads the packages the project depends on.

dotnet run

Builds the project and runs it immediately.

โœ… After dotnet run, check the message or address shown in the terminal.

3. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
cd kotlin

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

โœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
yarn install

Downloads and installs the libraries listed in package.json.

yarn build

Builds optimized production files.

yarn gen

Type this command into your terminal and run it.

yarn wipe && yarn gen

Type this command into your terminal and run it.

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

Type this command into your terminal and run it.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

5. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pipenv install

Type this command into your terminal and run it.

jupyter notebook

Launches Jupyter in your browser so you can open and run the notebook (.ipynb) files.

โœ… If it runs without errors and prints output in the terminal, it worked.

6. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
cd go

This project's files live in a subfolder, so move into it first.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

โœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.
// repository documentation