Archives/DocsGPT
2
0
Fork 0
mirror of https://github.com/arc53/DocsGPT synced 2024-11-19 21:25:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #610 from rahul0x00/enhance/quickstart

Browse Source 
Quickstart: Enhanced Documentation for Launching DocsGPT and Installing Chrome Extension
This commit is contained in:
Alex 2023-10-15 16:48:08 -05:00 committed by GitHub
commit aea6a434f1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 52 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
docs/pages/Deploying/Quickstart.md
View File

@ -1,20 +1,63 @@
## Launching Web App ## Launching Web App
Note: Make sure you have Docker installed **Note**: Make sure you have Docker installed
On macOS or Linux, just write: **On macOS or Linux:**
Just run the following command::
`./setup.sh` `./setup.sh`
It will install all the dependencies and give you an option to download the local model or use OpenAI This command will install all the necessary dependencies and provide you with an option to download the local model or use OpenAI.
Otherwise, refer to this Guide: 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`. 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). 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`. 3. Run the following commands:
`docker-compose build && docker-compose up`.
4. Navigate to `http://localhost:5173/`. 4. Navigate to `http://localhost:5173/`.
To stop, just run `Ctrl + C`. 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: For WINDOWS:
@ -57,7 +100,8 @@ These steps should help you set up and run the project on Windows using either W
### Chrome Extension ### Chrome Extension
To install the 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". 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. 2. Unzip the downloaded file to a location you can easily access.