Archives/DocsGPT
2
0
Fork 0
mirror of https://github.com/arc53/DocsGPT synced 2024-11-02 03:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
ed3a3d0876
DocsGPT/docs/pages/Deploying/Quickstart.md
Alex aea6a434f1
Merge pull request #610 from rahul0x00/enhance/quickstart 
Quickstart: Enhanced Documentation for Launching DocsGPT and Installing Chrome Extension
2023-10-15 16:48:08 -05:00

5.1 KiB
Raw Blame History

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 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.
  2. Create a .env file in your root directory and set your API_KEY with your OpenAI API key.
  3. Run the following commands: docker-compose build && docker-compose up.
  4. Navigate to http://localhost:5173/.

To stop, simply press Ctrl + C.

For WINDOWS:

To run the setup on Windows, you have two options: using the Windows Subsystem for Linux (WSL) or using Git Bash or Command Prompt.

Option 1: Using Windows Subsystem for Linux (WSL):

  1. Install WSL if you haven't already. You can follow the official Microsoft documentation for installation: (https://learn.microsoft.com/en-us/windows/wsl/install).
  2. After setting up WSL, open the WSL terminal.
  3. Clone the repository and create the .env file: 
    git clone https://github.com/arc53/DocsGPT.git
cd DocsGPT
echo "API_KEY=Yourkey" > .env
echo "VITE_API_STREAMING=true" >> .env
  4. Run the following command to start the setup with Docker Compose: ./run-with-docker-compose.sh
  5. Open your web browser and navigate to (http://localhost:5173/).
  6. To stop the setup, just press Ctrl + C in the WSL terminal

Option 2: Using Git Bash or Command Prompt (CMD):

  1. Install Git for Windows if you haven't already. Download it from the official website: (https://gitforwindows.org/).
  2. Open Git Bash or Command Prompt.
  3. Clone the repository and create the .env file: 
    git clone https://github.com/arc53/DocsGPT.git
cd DocsGPT
echo "API_KEY=Yourkey" > .env
echo "VITE_API_STREAMING=true" >> .env

4.Run the following command to start the setup with Docker Compose: ./run-with-docker-compose.sh 5.Open your web browser and navigate to (http://localhost:5173/). 6.To stop the setup, just press Ctrl + C in the Git Bash or Command Prompt terminal.

These steps should help you set up and run the project on Windows using either WSL or Git Bash/Command Prompt. Important: Ensure that Docker is installed and properly configured on your Windows system for these steps to work.

For WINDOWS:

To run the given setup on Windows, you can use the Windows Subsystem for Linux (WSL) or a Git Bash terminal to execute similar commands. Here are the steps adapted for Windows:

Option 1: Using Windows Subsystem for Linux (WSL):

  1. Install WSL if you haven't already. You can follow the official Microsoft documentation for installation: (https://learn.microsoft.com/en-us/windows/wsl/install).
  2. After setting up WSL, open the WSL terminal.
  3. Clone the repository and create the .env file: 
    git clone https://github.com/arc53/DocsGPT.git
cd DocsGPT
echo "API_KEY=Yourkey" > .env
echo "VITE_API_STREAMING=true" >> .env
  4. Run the following command to start the setup with Docker Compose: ./run-with-docker-compose.sh
  5. Open your web browser and navigate to (http://localhost:5173/).
  6. To stop the setup, just press Ctrl + C in the WSL terminal

Option 2: Using Git Bash or Command Prompt (CMD):

  1. Install Git for Windows if you haven't already. You can download it from the official website: (https://gitforwindows.org/).
  2. Open Git Bash or Command Prompt.
  3. Clone the repository and create the .env file: 
    git clone https://github.com/arc53/DocsGPT.git
cd DocsGPT
echo "API_KEY=Yourkey" > .env
echo "VITE_API_STREAMING=true" >> .env

4.Run the following command to start the setup with Docker Compose: ./run-with-docker-compose.sh 5.Open your web browser and navigate to (http://localhost:5173/). 6.To stop the setup, just press Ctrl + C in the Git Bash or Command Prompt terminal.

These steps should help you set up and run the project on Windows using either WSL or Git Bash/Command Prompt. Make sure you have Docker installed and properly configured on your Windows system for this to work.

Chrome Extension

Installing the Chrome extension:

To enhance your DocsGPT experience, you can install the DocsGPT Chrome extension. Here's how:

  1. In the DocsGPT GitHub repository, click on the "Code" button and select "Download ZIP".
  2. Unzip the downloaded file to a location you can easily access.
  3. Open the Google Chrome browser and click on the three dots menu (upper right corner).
  4. Select "More Tools" and then "Extensions".
  5. Turn on the "Developer mode" switch in the top right corner of the Extensions page.
  6. Click on the "Load unpacked" button.
  7. Select the "Chrome" folder where the DocsGPT files have been unzipped (docsgpt-main > extensions > chrome).
  8. The extension should now be added to Google Chrome and can be managed on the Extensions page.
  9. To disable or remove the extension, simply turn off the toggle switch on the extension card or click the "Remove" button.