Skip to content

Commit

Permalink
Merge pull request #775 from guspan-tanadi/markdownhighlightNote
Browse files Browse the repository at this point in the history
style(README): markdown highlight Note section
  • Loading branch information
dartpain authored Nov 15, 2023
2 parents 706e876 + 69d40b5 commit c14a9a5
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,8 @@ If you don't have enough resources to run it, you can use bitsnbytes to quantize

## QuickStart

Note: Make sure you have [Docker](https://docs.docker.com/engine/install/) installed
> [!Note]
> Make sure you have [Docker](https://docs.docker.com/engine/install/) installed
On Mac OS or Linux, write:

Expand Down Expand Up @@ -118,7 +119,8 @@ docker compose -f docker-compose-dev.yaml up -d

### Run the Backend

Make sure you have Python 3.10 or 3.11 installed.
> [!Note]
> Make sure you have Python 3.10 or 3.11 installed.
1. Export required environment variables or prepare a `.env` file in the `/application` folder:
- Copy [.env_sample](https://github.com/arc53/DocsGPT/blob/main/application/.env_sample) and create `.env` with your OpenAI API token for the `API_KEY` and `EMBEDDINGS_KEY` fields.
Expand Down Expand Up @@ -153,7 +155,8 @@ pip install -r requirements.txt

### Start Frontend

Make sure you have Node version 16 or higher.
> [!Note]
> Make sure you have Node version 16 or higher.
1. Navigate to the [/frontend](https://github.com/arc53/DocsGPT/tree/main/frontend) folder.
2. Install the required packages `husky` and `vite` (ignore if already installed).
Expand Down

2 comments on commit c14a9a5

@vercel
Copy link

@vercel vercel bot commented on c14a9a5 Nov 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-brown.vercel.app
docs-gpt-git-main-arc53.vercel.app
docs-gpt-arc53.vercel.app

@vercel
Copy link

@vercel vercel bot commented on c14a9a5 Nov 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-git-main-arc53.vercel.app
nextra-docsgpt.vercel.app
nextra-docsgpt-arc53.vercel.app
docs.docsgpt.co.uk

Please sign in to comment.