PsTuts-RAG / DEVELOPER.md
mbudisic's picture
Initial commit
b44bcb9
|
raw
history blame
1.24 kB

πŸ› οΈ Developer Documentation

πŸ“¦ Project Structure

.
β”œβ”€β”€ app.py              # Main Chainlit application
β”œβ”€β”€ requirements.txt    # Project dependencies
└── README.md          # User documentation

πŸ”§ Technical Details

The application uses Chainlit (v0.7.700+) to create a simple chat interface. The main functionality is implemented in app.py using the @cl.on_message decorator to handle incoming messages.

Key Components

  • @cl.on_message: Decorator that handles incoming messages from the chat interface
  • cl.Message: Class for creating and sending messages back to the user
  • Async/await pattern for handling message processing

πŸš€ Running Locally

  1. Create a virtual environment (recommended):
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
  1. Install dependencies:
pip install -r requirements.txt
  1. Run the development server:
chainlit run app.py

πŸ” Debugging

  • Chainlit provides a built-in debug mode. Run with:
chainlit run app.py --debug

πŸ“š Resources