💿 Developers - Installation via Python

• Step 1. Clone the repo

  git clone https://github.com/lvyv/spokenEnglish.git && cd spokenEnglish

• Step 2. Install requirements

  Install portaudio and ffmpeg for audio

  # for mac
  brew install portaudio
  brew install ffmpeg

  # for ubuntu
  sudo apt update
  sudo apt install portaudio19-dev
  sudo apt install ffmpeg

  Note:

  • ffmpeg>=4.4 is needed to work with torchaudio>=2.1.0

  • Mac users may need to add ffmpeg library path to DYLD_LIBRARY_PATH for torchaudio to work:

    export DYLD_LIBRARY_PATH=/opt/homebrew/lib:$DYLD_LIBRARY_PATH

    Then install all python requirements

    pip install -r requirements.txt

    If you need a faster local speech to text, install whisperX

    pip install git+https://github.com/m-bain/whisperx.git

• Step 3. Setup .env:

  cp .env.example .env

  Update API keys and configs following the instructions in the .env file.

  Note that some features require a working login system. You can get your own OAuth2 login for free with Firebase if needed. To enable, set USE_AUTH to true and fill in the FIREBASE_CONFIG_PATH field. Also fill in Firebase configs in client/next-web/.env.

• Step 4. Run backend server in Pycharm IDE：

• Step 5. Run frontend client:

  • web client:

    Create an .env file under client/next-web/

    cp client/next-web/.env.example client/next-web/.env

    Adjust .env according to the instruction in client/next-web/README.md.

    Start the frontend server:

    cd client/next-web
    npm install
    npm run dev

    After running these commands, a local development server will start, and your default web browser will open a new tab/window pointing to this server (usually http://localhost:3000).