Skip to content

Commit

Permalink
Updated env and Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Prathamesh Saraf committed Apr 18, 2024
1 parent 46a313a commit 9505ff1
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
4 changes: 4 additions & 0 deletions env.local.example
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,12 @@ LOG_LEVEL="DEBUG"
LOCAL=true

# Repository offers following categories of LLM providers to use from.


# One using OpenAI functions, OpenAI compatible LLMs and Embeddings can bee used either by setting `OPENAI_API_KEY`.
# OR
# One using Truefoundry LLM Gateway requires setting `TFY_API_KEY`, `TFY_LLM_GATEWAY_URL` and `TFY_HOST`.
# OR
# Another using entirely OpenSource LLMs (th' [Ollama](https://ollama.com/library).
# It requires setting `OLLAMA_URL` if hosted on different endpoint other than default in env file)

Expand Down
12 changes: 3 additions & 9 deletions frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,10 @@ npm install -g [email protected]

### Installation

1. Clone the repository:
1. Navigate into the project directory:

```bash
git clone https://github.com/truefoundry/docs-qa-playground.git
```

2. Navigate into the project directory:

```bash
cd docs-qa-playground/frontend
cd cognita/frontend
```

3. Install dependencies using Yarn:
Expand All @@ -69,7 +63,7 @@ Sample .env file:

```bash
VITE_QA_FOUNDRY_URL=http://localhost:8000
VITE_DOCS_QA_DELETE_COLLECTIONS=false
VITE_DOCS_QA_DELETE_COLLECTIONS=true
VITE_DOCS_QA_STANDALONE_PATH=/
VITE_DOCS_QA_ENABLE_REDIRECT=false
VITE_DOCS_QA_MAX_UPLOAD_SIZE_MB=200
Expand Down

0 comments on commit 9505ff1

Please sign in to comment.