LLM/DocsGPT
1
0
Fork 0
mirror of https://github.com/arc53/DocsGPT.git synced 2025-11-30 00:53:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

style(README): highlight markdown available Note section

Browse Source
This commit is contained in:
Guspan Tanadi
2023-11-13 19:17:13 +07:00
committed by GitHub
parent 6ee556e386
commit 7e8fb388a3
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -76,7 +76,8 @@ If you don't have enough resources to run it, you can use bitsnbytes to quantize
## QuickStart
Note: Make sure you have [Docker](https://docs.docker.com/engine/install/) installed
> [!Note]
> Make sure you have [Docker](https://docs.docker.com/engine/install/) installed
On Mac OS or Linux, write:
@@ -118,7 +119,8 @@ docker compose -f docker-compose-dev.yaml up -d
### Run the Backend
Make sure you have Python 3.10 or 3.11 installed.
> [!Note]
> Make sure you have Python 3.10 or 3.11 installed.
1. Export required environment variables or prepare a `.env` file in the `/application` folder:
- Copy [.env_sample](https://github.com/arc53/DocsGPT/blob/main/application/.env_sample) and create `.env` with your OpenAI API token for the `API_KEY` and `EMBEDDINGS_KEY` fields.
@@ -153,7 +155,8 @@ pip install -r requirements.txt
### Start Frontend
Make sure you have Node version 16 or higher.
> [!Note]
> Make sure you have Node version 16 or higher.
1. Navigate to the [/frontend](https://github.com/arc53/DocsGPT/tree/main/frontend) folder.
2. Install the required packages `husky` and `vite` (ignore if already installed).