mirror of
https://github.com/arc53/DocsGPT.git
synced 2025-11-29 16:43:16 +00:00
cc887d25e4
added windows Quickstart guide in Quickstart.md for easy to understand and make more user friendly
71 lines
3.1 KiB
Markdown
71 lines
3.1 KiB
Markdown
## Launching Web App
|
|
Note: Make sure you have Docker installed
|
|
|
|
On macOS or Linux, just write:
|
|
|
|
`./setup.sh`
|
|
|
|
It will install all the dependencies and give you an option to download the local model or use OpenAI
|
|
|
|
Otherwise, 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](https://platform.openai.com/account/api-keys).
|
|
3. Run `docker-compose build && docker-compose up`.
|
|
4. Navigate to `http://localhost:5173/`.
|
|
|
|
To stop, just run `Ctrl + C`.
|
|
|
|
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
|
|
|
|
To install the Chrome extension:
|
|
|
|
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.
|