update: documentation (#389)

* Update docker_install.md

update Bing Token instructions

* Update linux_install.md

Update Bing Token Instructions
Add # markers to sections

* Update mac_install.md

Update Bing Token Instructions
Fix Formating
Recommend Docker

* Update windows_install.md

Update Bing Token Instructions

* Update linux_install.md

Recommend Docker

* Create QUESTION.yml

Questions Template

* Update QUESTION.yml

fix syntax

* Update QUESTION.yml

* Update QUESTION.yml

* Create FEATURE-REQUEST

* Rename FEATURE-REQUEST to FEATURE-REQUEST.yml

add file extension

.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml

@@ -0,0 +1,57 @@
+name: Feature Request
+description: File a feature request
+title: "Enhancement]: "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill this!
+  - type: input
+    id: contact
+    attributes:
+      label: Contact Details
+      description: How can we get in touch with you if we need more info?
+      placeholder: ex. email@example.com
+    validations:
+      required: false
+  - type: textarea
+    id: what
+    attributes:
+      label: What functionality would you like to see added?
+      description: Please give as many details as possible
+      placeholder: Please give as many details as possible
+    validations:
+      required: true
+  - type: textarea
+    id: details
+    attributes:
+      label: More details
+      description: Please provide more details if you need to
+      placeholder: Please provide more details if you need to
+    validations:
+      required: true
+  - type: dropdown
+    id: subject
+    attributes:
+      label: What components are affected by your request?
+      multiple: true
+      options:
+        - General
+        - UI
+        - Endpoints
+        - Plugins
+        - Other
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Pictures
+      description: If applicable, add pictures to help explain your request. You can drag and drop, paste images directly here or link to them.
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/danny-avila/chatgpt-clone/blob/main/documents/contributions/code_of_conduct.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/ISSUE_TEMPLATE/QUESTION.yml

@@ -0,0 +1,58 @@
+name: Question
+description: Ask your question
+title: "[Question]: "
+labels: ["question"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill this!
+  - type: input
+    id: contact
+    attributes:
+      label: Contact Details
+      description: How can we get in touch with you if we need more info?
+      placeholder: ex. email@example.com
+    validations:
+      required: false
+  - type: textarea
+    id: what-is-your-question
+    attributes:
+      label: What is your question?
+      description: Please give as many details as possible
+      placeholder: Please give as many details as possible
+    validations:
+      required: true
+  - type: textarea
+    id: more-details
+    attributes:
+      label: More Details
+      description: Please provide more details if needed.
+      placeholder: Please provide more details if needed.
+    validations:
+      required: true
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: What is the main subject of your question?
+      multiple: true
+      options:
+        - Documentation
+        - Installation
+        - UI
+        - Endpoints
+        - User System/OAuth
+        - Other
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: If applicable, add screenshots to help explain your problem. You can drag and drop, paste images directly here or link to them.
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/danny-avila/chatgpt-clone/blob/main/documents/contributions/code_of_conduct.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

documents/install/docker_install.md

@@ -32,15 +32,16 @@
   
  **Create a MongoDB database**
  
-   - Navigate to https://www.mongodb.com/ and Sign In or Create an account
+Navigate to https://www.mongodb.com/ and Sign In or Create an account
-    - Create a new project
+
-    - Build a Database using the free plan and name the cluster (example: chatgpt-clone)
+- Create a new project
-    - Use the "Username and Password" method for authentication
+- Build a Database using the free plan and name the cluster (example: chatgpt-clone)
-    - Add your current IP to the access list
+- Use the "Username and Password" method for authentication
-    - In the Database Deployment tab, click on Connect
+- Add your current IP to the access list
-    - "Choose a connection method" select "Connect your application"
+- In the Database Deployment tab, click on Connect
-    - Driver = Node.js / Version = 4.1 or later
+- "Choose a connection method" select "Connect your application"
-    - Copy the connection string, fill in your password and remove `&w=majority` from default connection string.
+- Driver = Node.js / Version = 4.1 or later
+- Copy the connection string, fill in your password and remove `&w=majority` from default connection string.
 
 
 ##
@@ -52,12 +53,14 @@
 
    **Get your Bing Access Token**
    
-   - Using MS Edge, navigate to bing.com
+  Please follow the **[updated instructions.](https://github.com/danny-avila/chatgpt-clone/issues/370#issuecomment-1560382302)**
-    - Make sure you are logged in
+  
-    - Open the DevTools by pressing F12 on your keyboard
+  ~~Using MS Edge, navigate to bing.com~~
-    - Click on the tab "Application" (On the left of the DevTools)
+   - ~~Make sure you are logged in~~
-    - Expand the "Cookies" (Under "Storage")
+   - ~~Open the DevTools by pressing F12 on your keyboard~~
-    - Copy the value of the "\_U" cookie
+   - ~~Click on the tab "Application" (On the left of the DevTools)~~
+   - ~~Expand the "Cookies" (Under "Storage")~~
+   - ~~Copy the value of the "\_U" cookie~~
 
 ##
 

documents/install/linux_install.md

@@ -1,7 +1,10 @@
 # Linux Installation
-Thanks to @DavidDev1334 !
+## **Recommended : [Docker Install](docker_install.md)**
+
 ##
 
+## **Manual Installation**
+
 ## Prerequisites
 
 Before installing ChatGPT-Clone, make sure your machine has the following prerequisites installed:
@@ -12,13 +15,13 @@ Before installing ChatGPT-Clone, make sure your machine has the following prereq
 
 ## Installation Steps
 
-1. Clone the repository:
+## 1. Clone the repository:
 
 ```bash
 git clone https://github.com/danny-avila/chatgpt-clone.git
 ```
 
-2. Extract the content in your desired location:
+## 2. Extract the content in your desired location:
 
 ```bash
 cd chatgpt-clone
@@ -27,7 +30,7 @@ unzip chatgpt-clone.zip -d /usr/local/
 
 Note: The above command extracts the files to "/usr/local/chatgpt-clone". If you want to install the files to a different location, modify the instructions accordingly.
 
-3. Enable the Conversation search feature: (optional)
+## 3. Enable the Conversation search feature: (optional)
 
 - Download MeiliSearch latest release from: https://github.com/meilisearch/meilisearch/releases
 - Copy it to "/usr/local/chatgpt-clone/"
@@ -41,7 +44,7 @@ Note: The above command extracts the files to "/usr/local/chatgpt-clone". If you
 
 Note: Replace "YOUR_MASTER_KEY" with the generated master key, which you saved earlier.
 
-4. Install Node.js:
+## 4. Install Node.js:
 
 Open a terminal and run the following commands:
 
@@ -50,7 +53,7 @@ curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
 sudo apt-get install -y nodejs
 ```
 
-5. Create a MongoDB database:
+## 5. Create a MongoDB database:
 
 - Navigate to https://www.mongodb.com/ and sign in or create an account.
 - Create a new project.
@@ -62,18 +65,20 @@ sudo apt-get install -y nodejs
 - Driver = Node.js / Version = 4.1 or later.
 - Copy the connection string and save it somewhere (you will need it later).
 
-6. Get your OpenAI API key - Visit https://platform.openai.com/account/api-keys and save your API key somewhere safe (you will need it later)
+## 6. Get your OpenAI API key - Visit https://platform.openai.com/account/api-keys and save your API key somewhere safe (you will need it later)
 
-7. Get your Bing Access Token
+## 7. Get your Bing Access Token
+   
+  Please follow the **[updated instructions.](https://github.com/danny-avila/chatgpt-clone/issues/370#issuecomment-1560382302)**
+  
+  ~~Using MS Edge, navigate to bing.com~~
+   - ~~Make sure you are logged in~~
+   - ~~Open the DevTools by pressing F12 on your keyboard~~
+   - ~~Click on the tab "Application" (On the left of the DevTools)~~
+   - ~~Expand the "Cookies" (Under "Storage")~~
+   - ~~Copy the value of the "\_U" cookie~~
 
-- Using a web browser, navigate to bing.com
+## 8. Create the ".env" File
-- Make sure you are logged in
-- Open the browser DevTools by pressing F12 on your keyboard
-- Click on the tab "Application" (On the left of the DevTools)
-- Expand the "Cookies" (Under "Storage")
-- You need to copy the value of the "_U" cookie, save it somewhere, you will need it later
-
-8. Create the ".env" File
 
 You will need all your credentials, (API keys, access tokens, and MongoDB Connection String, MeiliSearch Master Key)
 
@@ -93,7 +98,7 @@ Setup the app:
 1. Run `npm ci`
 2. Run `npm run frontend`
 
-Start the app:
+## Start the app:
 1. Run `npm run backend`
 2. Run `meilisearch --master-key put_your_meilesearch_Master_Key_here` (Only if SEARCH=TRUE)
 3. Visit http://localhost:3080 (default port) & enjoy

documents/install/mac_install.md

@@ -1,10 +1,11 @@
 # Mac Install
-Thanks to @heathriel!
+## **Recommended : [Docker Install](docker_install.md)**
+
 ##
 
-**Recommended - [Docker Install](docker_install.md)**
+## **Manual Installation**
 
-## **Install the prerequisites**:
+## Install the prerequisites:
   - Install Homebrew (if not already installed) by following the instructions on https://brew.sh/
   - Install Node.js and npm by running `brew install node`
   - Install MongoDB (if not using Docker) by running `brew tap mongodb/brew` and `brew install mongodb-community`
@@ -22,14 +23,14 @@ Thanks to @heathriel!
     - Copy the connection string and save it somewhere(you will need it later)
 
 
- ## **Instructions:**
+ ## Instructions:
 
   - Open Terminal and clone the repository by running git clone https://github.com/danny-avila/chatgpt-clone.git
   - Change into the cloned directory by running cd chatgpt-clone
   - If using MongoDB Atlas, remove &w=majority from the default connection string
 Follow the instructions for setting up proxies, access tokens, and user system:
 
-### **Access Tokens:**
+### Access Tokens:
 
 **Get your OpenAI API key** 
 
@@ -40,16 +41,19 @@ Follow the instructions for setting up proxies, access tokens, and user system:
   - To get your Access token for ChatGPT 'Free Version', log in to chat.openai.com, then visit https://chat.openai.com/api/auth/session.
   - Warning: There may be a high chance of your account being banned with this method. Continue doing so at your own risk.
 
-**BingAI Instructions:**
+**Get your Bing Access Token**
-
+   
-  - To get the Bing Access Token, navigate to bing.com using a web browser such as Chrome or Safari, and ensure you're logged in.
+  Please follow the **[updated instructions.](https://github.com/danny-avila/chatgpt-clone/issues/370#issuecomment-1560382302)**
-  - Open the Developer Tools (in Chrome or Safari, press Cmd + Option + I).
+  
-  - Click on the "Application" tab (Chrome) or "Storage" tab (Safari).
+  ~~Using MS Edge, navigate to bing.com~~
-  - Expand the "Cookies" section under "Storage".
+   - ~~Make sure you are logged in~~
-  - Copy the value of the "_U" cookie and save it somewhere. You'll need it later.
+   - ~~Open the DevTools by pressing F12 on your keyboard~~
+   - ~~Click on the tab "Application" (On the left of the DevTools)~~
+   - ~~Expand the "Cookies" (Under "Storage")~~
+   - ~~Copy the value of the "\_U" cookie~~
 
 
-## **Setup Instruction**
+## Setup Instruction
   - Create a .env file in the api directory by running cp api/.env.example api/.env and edit the file with your preferred text editor, adding the required API keys, access tokens, and MongoDB connection string
   - Run npm ci from root directory `npm ci`
   - Build the client by running `npm run frontend`
@@ -85,7 +89,7 @@ MEILISEARCH_KEY=your_master_key_goes_here
   - In the chatgpt-clone directory, start the application by running `npm run backend`
 Visit http://localhost:3080 (default port) & enjoy
 
-## **Optional but recommended:**
+## Optional but recommended:
 
   - Create a script to automate the starting process by creating a new file named start_chatgpt.sh in the chatgpt-clone directory and pasting the following code:
 

documents/install/windows_install.md

@@ -46,13 +46,16 @@ or
   - **Get your OpenAI API key** 
 	  - here: https://platform.openai.com/account/api-keys and save it somewhere safe (you will need it later)
 
-  - **Get your Bing Access Token**
+   **Get your Bing Access Token**
-    - Using MS Edge, navigate to bing.com
+   
-    - Make sure you are logged in
+  Please follow the **[updated instructions.](https://github.com/danny-avila/chatgpt-clone/issues/370#issuecomment-1560382302)**
-    - Open the DevTools by pressing F12 on your keyboard
+  
-    - Click on the tab "Application" (On the left of the DevTools)
+  ~~Using MS Edge, navigate to bing.com~~
-    - Expand the "Cookies" (Under "Storage")
+   - ~~Make sure you are logged in~~
-    - You need to copy the value of the "\_U" cookie, save it somewhere, you will need it later
+   - ~~Open the DevTools by pressing F12 on your keyboard~~
+   - ~~Click on the tab "Application" (On the left of the DevTools)~~
+   - ~~Expand the "Cookies" (Under "Storage")~~
+   - ~~Copy the value of the "\_U" cookie~~
 
 - **Create the ".env" File** 
 You will need all your credentials, (API keys, access tokens, and Mongo Connection String, MeileSearch Master Key)