🎀🔔 Red Jingles 🎀🔔

A state-of-the-art holiday theme based AI chatbot focusing on scalability, extensibility and real world applicability

About

This project was made as a submission to Serverless Holiday Hackathon 2023. Read the full submission article here.

The world has witnessed AI's potential thanks to platforms like OpenAI. It's crucial that AI isn't just limited to tech experts but accessible to everyone. Red Jingles is our attempt to create a chatbot backed by LLM with a Christmas theme featuring Santa Claus, Snowman, and Elf.

Getting Started

Try the Hosted Version

Application is hosted here API is hosted here

Running with Docker

1. Ensure you have Docker installed on your machine. If not, follow the official Docker installation guide.

2. Run the container:

   docker run -p 1225:8080 \
   -e CHAINLIT_URL=http://localhost:1225 \
   -e DISABLE_AUTH=true \
   -e OPENAI_API_KEY=<YOUR_OPENAI_API_KEY> \
   jbhv12/red-jingles:latest

3. Open your browser and go to http://localhost:1225 to view the app.

Running from Code

If you prefer running the app directly from the source code, follow these steps:

1. Make sure you have python installed.

2. Clone the repository:

   git clone https://github.com/jbhv12-12/red-jingles.git

3. Navigate to the project directory:

   cd red-jingles/app

4. Install dependencies:

   pip install -r requirements.txt

5. Run the application:

   chainlit run ./app.py --port 1225 -w

6. Open your browser and go to http://localhost:1225 to view the app.

7. Run the API (optional)

   python api_server.py 

8. Open your browser and go to http://localhost:8080 to view the API documentation.

Using hosted APIs

API is hosted here

1. Click on "Authorize" button on top right to authenticate yourself with your red-jingles credentials.
2. Leave all input fields empty as is.
3. Enter your creds when prompted
4. Try out any API from UI. Notice a token passed in each request after authentication.

Architecture and Documentation

Read the full submission article here.

License

This project is licensed under the [Your License] - see the LICENSE.md file for details.