Skip to content

Commit

Permalink
readme fix (miku-gg#73), fix windows install (miku-gg#76), add backen…
Browse files Browse the repository at this point in the history
…d_config to correct .gitignore
  • Loading branch information
ewof committed Jan 14, 2024
1 parent 37b6a4f commit 3bd9bf1
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 5 deletions.
3 changes: 2 additions & 1 deletion apps/services/.gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
node_modules/
dist/
_temp/*
!_temp/.gitkeep
!_temp/.gitkeep
backend_config.json
4 changes: 1 addition & 3 deletions docs/src/guides/run-local.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,10 @@ This command will check the dependencies and install the required packages for `

Next, you will be prompted for the environment variables

* `OPENAI_ENDPOINT`, the OAI-like endpoint (Aphrodite/Ooba/Tabby)
* `OPENAI_KEY`, the password for the OAI-like endpoint (Aphrodite/Ooba/Tabby)
* `AZURE_API_KEY`, a valid API for querying Azure TTS models
* `ELEVENLABS_API_KEY`, a valid API for querying ElevenLabs TTS models

An `OPENAI_API_KEY` must be provided for the bots to generate responses. You can take a look at the [How to use the endpoints](/guides/how-to-endpoints) guide for getting one of these values.
Backend API keys and URLs are set in the bot directory config. You can take a look at the [How to use the endpoints](/guides/how-to-endpoints) guide for getting one of these values.

### 3. Run the project
After setting up the `.env` file, you can run the project by running the following command:
Expand Down
2 changes: 1 addition & 1 deletion install.bat
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ call npm --version >nul 2>&1 || (
echo Node.js is installed.

echo Installing Node.js dependencies...
del /q/s apps\interactor\node_modules\.vite > nul 2>&1 || exit
rem /q/s apps\interactor\node_modules\.vite > nul 2>&1 || exit
call npm install -g pnpm 0
call pnpm install
if errorlevel 1 (
Expand Down

0 comments on commit 3bd9bf1

Please sign in to comment.