opensearch-api-specification

(β˜… 62)

API specification for OpenSearch

File Explorer

Download Latest Version (.zip)
  • .cspell
  • .gitignore
  • .lycheeignore
  • .vale.ini
  • .whitesource
  • _config.yml
  • ADMINS.md
  • CHANGELOG.md
  • CLIENT_GENERATOR_GUIDE.md
  • CODE_OF_CONDUCT.md
  • codecov.yml
  • CONTRIBUTING.md
  • DEVELOPER_GUIDE.md
  • eslint.config.mjs
  • favicon.ico
  • Gemfile
  • Gemfile.lock
  • index.html
  • jest.config.js
  • LICENSE.txt
  • MAINTAINERS.md
  • NOTICE.txt
  • package-lock.json
  • package.json
  • PUBLISHING_GUIDE.md
  • README.md
  • RELEASING.md
  • SECURITY.md
  • TESTING_GUIDE.md
  • tsconfig.json

# Installation Guide

1. Get the code
git clone https://github.com/opensearch-project/opensearch-api-specification

Downloads the entire project code from GitHub to your computer.

cd opensearch-api-specification

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f coverage/Dockerfile -t opensearch-api-specification .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 opensearch-api-specification

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. 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.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

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

4. 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.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
pipenv install

Type this command into your terminal and run it.

python <μ‹€ν–‰ν•  파일λͺ…>.py # READMEμ—μ„œ μ •ν™•ν•œ μ‹€ν–‰ 파일λͺ…을 ν™•μΈν•˜μ„Έμš”

Runs the Python script (or module).

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

5. Ruby

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Ruby Ruby is required to use the bundle command.
bundle install

Installs the Ruby libraries listed in the Gemfile.

βœ… If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).

Today's picks

whisper β˜… 107,730

Robust Speech Recognition via Large-Scale Weak Supervision

Python
papers-we-love β˜… 108,897

Papers from the computer science community to read and discuss.

Shell
deno β˜… 108,275

A modern runtime for JavaScript and TypeScript.

Rust
vite β˜… 82,446

Next generation frontend tooling. It's fast!

TypeScript
awesome-scalability β˜… 73,436

The Patterns of Scalable, Reliable, and Performant Large-Scale Systems
freeCodeCamp β˜… 454,412

freeCodeCamp.org's open-source codebase and curriculum. Learn math, programming, and compu

TypeScript
// repository documentation