An open API service indexing awesome lists of open source software.

https://github.com/sourav014/miniperplexityai

Minimal version of Q&A system like Perplexity.ai
https://github.com/sourav014/miniperplexityai

ai-search-engine gpt large-language-models miniperplexityai python search-engine searchgpt

Last synced: 6 months ago
JSON representation

Minimal version of Q&A system like Perplexity.ai

Awesome Lists containing this project

README

          

# [miniperplexity.ai](https://miniperplexityai.up.railway.app/)
Minimal version of Q&A system like Perplexity.ai

Setting Up the Repository Locally
=================================
Setting up this project is straightforward. Follow the steps below to prepare your local environment.
### Prerequisites
Ensure the following are installed and configured before proceeding:
1. **Python** - [Download Python](https://www.python.org/downloads/)

2. **API Keys**

* **OpenAI API Key** - [Generate here](https://platform.openai.com/account/api-keys)

* **Google Custom Search API Key** and **Search Engine ID** or **Bing API Key**

* For Google, create a Custom Search API Key and a Search Engine ID

* For Bing, [create a Bing Search API Key](https://www.microsoft.com/en-us/bing/apis/bing-search-api-v7)

### Steps to Set Up
1. Clone the repository:
```
git clone https://github.com/sourav014/miniperplexityAI.git
```

2. Install dependencies: Navigate to the project directory and install required packages from requirements.txt:
```
cd miniperplexityAI
pip install -r requirements.txt
```

3. Configure environment variables: Create a .env file in the project root and add your configuration values:
```
SERVER_PORT="8080"
GOOGLE_CUSTOM_SEARCH_API_KEY="your-google-custom-search-api-key"
SEARCH_ENGINE_ID="your-search-engine-id"
BING_API_KEY="your-bing-api-key"
OPENAI_API_KEY="your-openai-api-key"
```

4. Start the server: Run the application:
```
python3 app.py
```

Setting Up the Repository Locally using Docker
==============================================
1. Clone the repository:
```
git clone https://github.com/sourav014/miniperplexityAI.git
```
2. Navigate to the project directory
```
cd miniperplexityAI
```
3. Configure environment variables: Create a .env file in the project root and add your configuration values:
```
SERVER_PORT="8080"
GOOGLE_CUSTOM_SEARCH_API_KEY="your-google-custom-search-api-key"
SEARCH_ENGINE_ID="your-search-engine-id"
BING_API_KEY="your-bing-api-key"
OPENAI_API_KEY="your-openai-api-key"
```
4. Build the docker image:
```
sudo docker build -t miniperplexityai .
```
4. Start the container:
```
sudo docker run -d --name miniperplexityai_container -p 8080:8080 miniperplexityai
```

After completing the setup, open your favorite browser and navigate to http://127.0.0.1:8080/ to start interacting with the application.

We know developers often prefer a dark theme, but currently, this application does not support it. Thank you for your patience, and enjoy exploring the app!