hypercheap-voiceAI

(β˜… 146)

The most cost-effective, highest performance AI voice agent possible today

  • .gitignore
  • CONTRIBUTING.md
  • LICENSE
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/jordan-gibbs/hypercheap-voiceAI

Downloads the entire project code from GitHub to your computer.

cd hypercheap-voiceAI

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 -t hypercheap-agent:latest -f voice_backend/Dockerfile .

Builds a runnable image based on the Dockerfile.

docker run --env-file voice_backend/.env -p 8000:8000 hypercheap-agent:latest

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.

Pulled directly from this repo's README.

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 run dev

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.

Pulled directly from this repo's README.

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.
pip install -r requirements.txt

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

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

Pulled directly from this repo's README.

// repository documentation