ResearchGPT

An AI assistant to help you with with your research

---

UI Screenshots

---

---

Server Setup

1. Install poetry
2. Install python version >= 3.11.1
3. Install dependencies poetry install
4. Create .env file from example cp config/.env.example config/.env
5. Visit openai to obtain your API key and then place it after OPENAI_API_KEY= in config/.env

Local Server

• Use VSCode run and debug play button, repo include .vscode/launch.json file
• You should see the below sample stdout

INFO: Started server process [20149]
INFO: Waiting for application startup.
[2023-05-17 15:03:21,196] FastAPI:CRITICAL - MySQL DB connected!
[2023-05-17 15:03:22,103] FastAPI:CRITICAL - Redis CACHE connected!
INFO: Application startup complete.

• You can use curl http://127.0.0.1:8000 to check if the server is running or not, you'll get {"message":"Server is running..."} in response

Prod Server

• sudo chmod +x certbot.sh && sudo ./certbot.sh
• sudo docker-compose --env-file config/.env up -d --build --remove-orphans
• sudo docker-compose --env-file config/.env down && sudo docker system prune --force --all
• sudo docker exec -it researchgpt_api_1 cat log/app.log

---

Client Setup

A brief description of the project.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them.