A simple tool to parse your paper and help fill the ACL responsible checklist.

---

Installation | Documentation

---

Overview

This repository:

• is an easy-to-use Llama or GPT powered web interface which can be used to empower authors to reflect on their work and assist authors with conference checklists
• is highly flexible and offers various adaptations and possibilities such as prompt customization, enabling developers to continue developing this tool for additional conferences

An overview of ConfReady is presented in this YouTube video.

Installation

Prerequisites

• Conda (Miniconda or Anaconda)

Steps

1. Clone the repository and navigate to the project directory:

   git clone https://github.com/gtfintechlab/ConfReady.git
   cd ConfReady

2. Run the installation script:

   source install.sh

3. Add your API keys:

   • Add LLM inference provider API keys to the .env file inside the server directory.

   TOGETHERAI_API_KEY=your_together_ai_key_here
   OPENAI_API_KEY=your_openai_key_here

Run the App

1. Run the Flask server:

   cd server
   python app.py

2. Run the Web Interface:

   cd confready
   npm start

3. Access the API:

   The server will be running on http://localhost:3000/.

Documentation

We welcome contributions to this library and encourage potential contributors to start by reviewing our documentation to familiarize themselves with the codebase's format and structure. Once you have a solid understanding, feel free to submit a pull request. We’re excited to collaborate with new contributors and drive this project forward together.