Skip to content

Commit

Permalink
Merge pull request #610 from rahul0x00/enhance/quickstart
Browse files Browse the repository at this point in the history
Quickstart: Enhanced Documentation for Launching DocsGPT and Installing Chrome Extension
  • Loading branch information
dartpain authored Oct 15, 2023
2 parents 6c95d5a + 832569a commit aea6a43
Showing 1 changed file with 52 additions and 8 deletions.
60 changes: 52 additions & 8 deletions docs/pages/Deploying/Quickstart.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,63 @@
## 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`

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).
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/`.

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:

Expand Down Expand Up @@ -57,7 +100,8 @@ These steps should help you set up and run the project on Windows using either W

### 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".
2. Unzip the downloaded file to a location you can easily access.
Expand Down

2 comments on commit aea6a43

@vercel
Copy link

@vercel vercel bot commented on aea6a43 Oct 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

nextra-docsgpt – ./docs

nextra-docsgpt-arc53.vercel.app
nextra-docsgpt.vercel.app
nextra-docsgpt-git-main-arc53.vercel.app
docs.docsgpt.co.uk

@vercel
Copy link

@vercel vercel bot commented on aea6a43 Oct 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

docs-gpt – ./frontend

docs-gpt-git-main-arc53.vercel.app
docs-gpt-brown.vercel.app
docs-gpt-arc53.vercel.app

Please sign in to comment.