Launching Web App

Note: Make sure you have Docker installed

On macOS or Linux: Just run the following command:

./setup.sh

This command will install all the necessary dependencies and provide you with an option to use our LLM API, download the local model or use OpenAI.

If you prefer to follow manual steps, refer to this guide:

1. Open and download this repository with

   git clone https://github.com/arc53/DocsGPT.git
   cd DocsGPT

2. Create a .env file in your root directory and set the env variables. It should look like this inside:

   LLM_NAME=[docsgpt or openai or others] 
   API_KEY=[if LLM_NAME is openai]

   See optional environment variables in the /application/.env_sample (opens in a new tab) file.

3. Run the following commands:

   docker compose up

4. Navigate to http://localhost:5173/ (opens in a new tab).

To stop, simply press Ctrl + C.

For WINDOWS:

1. Open and download this repository with

   git clone https://github.com/arc53/DocsGPT.git
   cd DocsGPT

2. Create a .env file in your root directory and set the env variables. It should look like this inside:

   LLM_NAME=[docsgpt or openai or others] 
   API_KEY=[if LLM_NAME is openai]

   See optional environment variables in the /application/.env_sample (opens in a new tab) file.

3. Run the following command:

   docker-compose up

4. Navigate to http://localhost:5173/ (opens in a new tab).

5. To stop the setup, just press Ctrl + C in the WSL terminal

Important: Ensure that Docker is installed and properly configured on your Windows system for these steps to work.