Giter VIP home page Giter VIP logo

ask_pdf's Introduction

Ask the PDF ๐Ÿ“–โ“

animated

Prerequisites

  • Docker and Docker Compose

Setup Using Docker Compose

  1. Clone the repository to your local machine:

    git clone https://github.com/mikkac/ask_pdf
    cd ask_pdf
  2. Create a .env file in the project root directory with your OpenAI API key:

    OPENAI_API_KEY=your_api_key_here
  3. Use Docker Compose to build and run the application:

    docker-compose up --build

    This command will build the Docker images for the project and start the containers as defined in your docker-compose.yml file.

  4. Once the containers are up and running, you can access the application:

    • Streamlit App: Open http://localhost:8501 in your browser (or the port you configured in docker-compose.yml).
    • FastAPI Server: Available at http://localhost:8000 (or the port you configured in docker-compose.yml).

Stopping the Application

To stop the application, you can use the following command in the terminal:

docker-compose down

This will stop and remove the containers and networks created by docker-compose up.

License

This project is licensed under the MIT License - see the LICENSE file for details.

ask_pdf's People

Contributors

mikkac avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.