added readme file

This commit is contained in:
charlene tau express 2025-03-17 16:04:38 +08:00
parent 732e62d284
commit b807396de8
2 changed files with 49 additions and 2 deletions

2
.env
View File

@ -1,2 +0,0 @@
TOKENIZER_FOLDER=/home/charlenewsl/model-files/tokenizer
MODEL_FOLDER=/home/charlenewsl/model-files

49
README.md Normal file
View File

@ -0,0 +1,49 @@
## How to Run This Project
### 1⃣ Create and Activate a Virtual Environment
Run the following command to create a virtual environment:
```sh
python -m venv venv
```
### Activate the Virtual Environment
**On macOS/Linux:**
```sh
source venv/bin/activate
```
### 2⃣ Install Dependencies
After activating the virtual environment, install the required packages:
```sh
pip install -r requirements.txt
```
### 3⃣ Run the Flask Application
Once dependencies are installed, start the Flask app by running:
```sh
python src/app.py
```
## Environment Variables
This project requires a `.env` file for configuration.
### **.env File Placement**
- Place the `.env` file **one folder before** the `util` directory.
- Example folder structure:
### **Example `.env` File**
```ini
QDRANT_HOST = "localhost"
QDRANT_PORT = 6333
QDRANT_API_KEY=''
QDRANT_CLUSTER=''
QDRANT_COLLECTION_NAME='titan'
TOKENIZER_FOLDER=''
MODEL_FOLDER=''