Merge pull request #41 from thivy/main

code cleanup and restructure of components library

README.md

@@ -65,38 +65,40 @@ Clone this repository locally or fork to your Github account. Run all of the the
 2. Create a new file named `.env.local` to store the environment variables add the following variables.
 
 **Please note:**
+
 - Do not use double-quotes and do not delete any of the variables.
 - Make sure that `NEXTAUTH_URL=http://localhost:3000` has no comments in the same line.
 
-   ```
-   # Azure OpenAI configuration
-   AZURE_OPENAI_API_KEY=
-   AZURE_OPENAI_API_INSTANCE_NAME=
-   AZURE_OPENAI_API_DEPLOYMENT_NAME=
-   AZURE_OPENAI_API_VERSION=
+  ```
+  # Azure OpenAI configuration
+  AZURE_OPENAI_API_KEY=
+  AZURE_OPENAI_API_INSTANCE_NAME=
+  AZURE_OPENAI_API_DEPLOYMENT_NAME=
+  AZURE_OPENAI_API_VERSION=
 
-   # GitHub OAuth app configuration
-   AUTH_GITHUB_ID=
-   AUTH_GITHUB_SECRET=
+  # GitHub OAuth app configuration
+  AUTH_GITHUB_ID=
+  AUTH_GITHUB_SECRET=
 
-   # Azure AD OAuth app configuration
-   AZURE_AD_CLIENT_ID=
-   AZURE_AD_CLIENT_SECRET=
-   AZURE_AD_TENANT_ID=
+  # Azure AD OAuth app configuration
+  AZURE_AD_CLIENT_ID=
+  AZURE_AD_CLIENT_SECRET=
+  AZURE_AD_TENANT_ID=
 
-   # When deploying to production, 
-   # set the NEXTAUTH_URL environment variable to the canonical URL of your site. 
-   # More information: https://next-auth.js.org/configuration/options
+  # When deploying to production,
+  # set the NEXTAUTH_URL environment variable to the canonical URL of your site.
+  # More information: https://next-auth.js.org/configuration/options
 
-   NEXTAUTH_SECRET=
-   NEXTAUTH_URL=http://localhost:3000
+  NEXTAUTH_SECRET=
+  NEXTAUTH_URL=http://localhost:3000
 
-   AZURE_COSMOSDB_URI=
-   AZURE_COSMOSDB_KEY=
-   ```
+  AZURE_COSMOSDB_URI=
+  AZURE_COSMOSDB_KEY=
+  ```
 
-4. Install npm packages by running `npm install`
-5. Start the project by running `npm run dev`
+4. change the active directory to be `src`
+5. Install npm packages by running `npm install`
+6. Start the project by running `npm run dev`
 
 You should now be prompted to login with your chosen OAuth provider. Once successfully logged in, you can start creating new conversations.
 

src/.env.example

@@ -7,14 +7,13 @@ AZURE_OPENAI_API_INSTANCE_NAME=
 AZURE_OPENAI_API_DEPLOYMENT_NAME=
 AZURE_OPENAI_API_VERSION=2023-03-15-preview
 
-# Use GitHub environment variables if you’re not using Azure AD auth
+# You must have atleast one of the following auth providers configured
 AUTH_GITHUB_ID=
 AUTH_GITHUB_SECRET=
 
-# Use Azure AD environment variables if you're not using GitHub auth
-# AZURE_AD_CLIENT_ID=
-# AZURE_AD_CLIENT_SECRET=
-# AZURE_AD_TENANT_ID=
+AZURE_AD_CLIENT_ID=
+AZURE_AD_CLIENT_SECRET=
+AZURE_AD_TENANT_ID=
 
 # Update your production URL in NEXTAUTH_URL
 NEXTAUTH_SECRET=AZURE-OPENIAI-CHATGPT-NEXTAUTH-OWNKEY@1