quepid

(โ˜… 342)

Improve your OpenSearch, Elasticsearch, Solr, Vectara, Algolia and Custom Search search quality.

  • .annotaterb.yml
  • .browserslistrc
  • .database_consistency.todo.yml
  • .database_consistency.yml
  • .deepsource.toml
  • .dockerignore
  • .editorconfig
  • .env.example
  • .gitattributes
  • .gitignore
  • .jshintrc
  • .nvmrc
  • .pre-commit-config.yaml
  • .rubocop.yml
  • .ruby-version
  • .stylelintignore
  • .stylelintrc.json
  • app.json
  • audit_css.js
  • build_angular_app.js
  • build_css.js
  • build_templates.js
  • CHANGELOG.md
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • config.ru
  • DEVELOPER_GUIDE.md
  • docker-compose.override.yml.example
  • docker-compose.prod.yml
  • docker-compose.yml
  • Dockerfile.dev
  • Dockerfile.prod
  • Gemfile
  • Gemfile.lock
  • LICENSE
  • nginx.conf
  • package.json
  • Procfile
  • Procfile.dev
  • Rakefile
  • README.md
  • renovate.json
  • wait-for
  • yarn.lock

# Installation Guide

1. Get the code
git clone https://github.com/o19s/quepid

Downloads the entire project code from GitHub to your computer.

cd quepid

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 -f deployment/quepid-docker-deploy/docker-compose.yml up -d --build

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.

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