Introduction

Prerequisites

• Python 3.11+
• NPM (Node.js) — required for the web interface
  • Download Node.js & NPM

Installation Methods

You can install ConfReady in two ways:

1. PyPI (Recommended)

Install ConfReady from PyPI:

pip install confready

This will install all required Python dependencies. If you want to use the web interface, ensure you have NPM installed as well.

2. GitHub (Development-Friendly)

If you want to contribute or run the latest development version, install via GitHub:

1. Clone the repository and navigate to the project directory:
   git clone https://github.com/gtfintechlab/ConfReady.git
   cd ConfReady
   

2. Install Python dependencies:
   pip install -r requirements.txt
   

3. Install frontend dependencies (for the web interface):
   cd confready
   npm install
   cd ..
   

4. Add your API keys to a .env file in the root or as prompted:
   OPENAI_API_KEY=your_openai_key_here
   TOGETHERAI_API_KEY=your_togetherai_key_here
   

5. Run the backend server:
   python app.py
   

6. Run the frontend (in a new terminal):
   cd confready
   npm start
   

• Backend: http://localhost:8080
• Frontend: http://localhost:3000

API Keys

ConfReady requires API keys for LLM inference:

• TOGETHERAI_API_KEY
• OPENAI_API_KEY

You will be prompted to enter your API keys if they are missing. The CLI will save them to the appropriate .env file for you.

Usage

To start ConfReady, simply run:

confready run

This command will automatically launch both the backend (Flask server) and the frontend (React web interface):

• Backend: http://localhost:8080
• Frontend: http://localhost:3000

Note:

• Make sure ports 8080 and 3000 are free before running confready run.
• The first time you run the command, you will be prompted to enter your API keys if they are missing.

Features

• Upload LaTeX documents (.tex, .zip, .tar.gz) or PDF files for checklist analysis
• Supports ACL, NeurIPS, and other conference checklists
• Advanced retrieval and reranking for accurate responses
• Extensible for new conferences and custom prompts

Troubleshooting

• Ensure you have both Python 3.11+ and NPM installed and available in your PATH.
• If you encounter issues with missing dependencies, reinstall with:
  pip install --upgrade --force-reinstall confready
  

• Make sure your API keys are correct and present in the .env file.

Documentation & Contribution

• Full documentation: https://confready-docs.vercel.app/docs/introduction
• We welcome contributions! Please read the docs and submit a pull request.