---
title: DRAGON Innovation
emoji: 🐉
colorFrom: pink
colorTo: indigo
sdk: gradio
sdk_version: 4.21.0
app_file: app.py
pinned: false
---

# README

## Instructions for using d-RAGon
We recommend experiencing d-RAGon through the online demo hosted on huggingface at [DRAGON_innovation](https://huggingface.co/spaces/how2traindragon/DRAGON_innovation)

## Instructions for Running d-RAGon locally

Follow the instructions below to set up and run the application locally on your system.

### Prerequisites

Ensure you have Python installed on your system. You can download it from [python.org](https://www.python.org/downloads/). The version used in the online demo is 3.10.

### API keys

You would require a valid LTA DataMall API key and a valid openAI API key of your own provisioning to run the application locally.
LTA DataMall API key can be applied for [here](https://datamall.lta.gov.sg/content/datamall/en/request-for-api.html) and openAI API key can be generated [here](https://platform.openai.com/api-keys) (credit topup is required to utilise openAI API).

You can provide the API keys in one of two ways: \
(1) Uncommenting lines 34-35 in app.py AND adding the keys to the .env file in the project directory, OR;\
(2) Uncommenting lines 38-39 and Directly pasting the keys into the two lines

### Installation (via terminal/cmd)

1. Clone or download the repository to your local machine:
```
# Make sure you have git-lfs installed (https://git-lfs.com)
git lfs install

git clone https://huggingface.co/spaces/how2traindragon/DRAGON_innovation
```

2. Navigate to the project directory (~/DRAGON_innovation) and install the required dependencies:
```
pip install -r requirements.txt
```

3. Once the dependencies are installed, you can run the application by executing the following command:
```
python app.py
```

4. The application should now be up and running. You can access it by navigating to the link in your command line interface in your web browser.

### Additional Notes

- If you encounter any issues during installation or while running the application, please feel free to contact the developers for assistance.

- For more detailed information about the application and its usage, please refer to the bundled information video.

- Enjoy using the application!