phantoscope

(โ˜… 142)

Open Source, Cloud Native, RESTful Search Engine Powered by Neural Networks

  • .dockerignore
  • .gitignore
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • docker-compose-test.yml
  • docker-compose.yml
  • Dockerfile
  • LICENSE
  • Makefile
  • pylint.conf
  • README.md
  • README_CN.md
  • requirements.txt

# Installation Guide

1. Get the code
git clone https://github.com/zilliztech/phantoscope

Downloads the entire project code from GitHub to your computer.

cd phantoscope

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-compose up -d

Runs the command against the services defined in the compose file.

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

Pulled directly from this repo's README.

3. 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.
pip install -r operators/example-custom-operator/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <์‹คํ–‰ํ•  ํŒŒ์ผ๋ช…>.py # README์—์„œ ์ •ํ™•ํ•œ ์‹คํ–‰ ํŒŒ์ผ๋ช…์„ ํ™•์ธํ•˜์„ธ์š”

Runs the Python script (or module).

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

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation