haystack

(โ˜… 314)

Top level repository for Haystack, containing documentation and deployment scripts

  • .gitignore
  • .travis.yml
  • CODE_OF_CONDUCT.md
  • LICENSE
  • README.md
  • renovate.json

# Installation Guide

1. Get the code
git clone https://github.com/ExpediaDotCom/haystack

Downloads the entire project code from GitHub to your computer.

cd haystack

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.
โš ๏ธ 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.
docker build -f deployment/grafana/build/docker/Dockerfile -t haystack .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 haystack

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.
cd docsite

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

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.
// repository documentation