Merge pull request SamurAIGPT#36 from ashtrindade/main

Add Dockerfile and docker-compose.yml

.gitignore

@@ -0,0 +1,2 @@
+.vs
+.vscode

README.md

@@ -4,37 +4,59 @@ Create a QnA chatbot on your documents without relying on the internet by utiliz
 
 <img width="948" alt="pgpt" src="https://github.com/SamurAIGPT/privateGPT/assets/4326215/76e24cd4-a890-4253-bb87-098c4f1328fd">
 
-### Getting started
+## Contents
+
+* [Getting started](#getting-started)
+* [Requirements](#requirements)
+* [How to run](#how-to-run)
+* [Support](#support)
+* [Data](#data)
+* [Check repos](#check-repos)
+
+## Getting started
 
 Code is up, ⭐ (Star) the repo meanwhile to receive updates
 
 Follow [Anil Chandra Naidu Matcha](https://twitter.com/matchaman11) & [Ankur Singh](https://twitter.com/ankur_maker) on twitter for updates
 
-### Requirements
+## Requirements
+
 * Python 3.8 or later
 * Minimum 16GB of memory
 
-# How to run
+## How to run
 
 1. Go to client folder and run the below commands
-   * npm install
-   * npm run dev
-
+
+   ```shell
+   npm install   
+   ```
+
+   ```shell
+   npm run dev
+   ```
+
 2. Go to server folder and run the below commands
-   * pip install -r requirements.txt
-   * python privateGPT.py
 
-3. Open localhost:3000, click on download model to download the required model initially
+   ```shell
+   pip install -r requirements.txt
+   ```
+
+   ```shell
+   python privateGPT.
+   ```
+
+3. Open <http://localhost:3000>, click on download model to download the required model initially
 
 4. Upload any document of your choice and click on Ingest data. Ingestion is fast
 
 5. Now run any query on your data. Data querying is slow and thus wait for sometime
 
-### Support
+## Support
 
-Join our discord https://discord.gg/A6EzvsKX4u to get support
+Join our discord <https://discord.gg/A6EzvsKX4u> to get support
 
-### Data
+## Data
 
 The supported extensions for documents are:
 
@@ -51,11 +73,8 @@ The supported extensions for documents are:
 * .pptx : PowerPoint Document,
 * .txt: Text file (UTF-8),
 
-### Check repos
-
-* LANGCHAIN COURSE https://github.com/SamurAIGPT/langchain-course
-* CHATGPT DEVELOPER PLUGINS https://github.com/SamurAIGPT/ChatGPT-Developer-Plugins
-* CAMEL AGI https://github.com/SamurAIGPT/Camel-AutoGPT
-
-
+## Check repos
 
+* [Langchain Course](https://github.com/SamurAIGPT/langchain-course)
+* [ChatGPT Developer Plugins](https://github.com/SamurAIGPT/ChatGPT-Developer-Plugins)
+* [Camel AGI](https://github.com/SamurAIGPT/Camel-AutoGPT)

client/.gitignore

@@ -0,0 +1,2 @@
+node_modules
+.next