Updated readme file

README.md

@@ -1,52 +1,91 @@
 # RAGGI AI-Oracle
 
-more text will be added soon...
+RAGGI AI-Oracle is an application designed to leverage AI for advanced document handling and natural language processing. This repository contains both backend and frontend components to get the application up and running.
 
-# Installation
+## Installation
 
-## Backend
+### Backend
 
-create a virtual env
+1. **Create a virtual environment:**
 
-> python -m venv venv
+   ```bash
+   python -m venv venv
+   ```
 
-install all packages
+2. **Activate the virtual environment:**
 
-> pip install -r requirements.txt
+   - On Windows:
+     ```bash
+     venv\Scripts\activate
+     ```
+   - On macOS/Linux:
+     ```bash
+     source venv/bin/activate
+     ```
 
-run following command to run the dev server
+3. **Install all required packages:**
 
-> fastapi dev
+   ```bash
+   pip install -r requirements.txt
+   ```
 
-## Frontend
+4. **Run the development server:**
 
-navigate to **frontend/raggi** folder and following command to install all packages needed:
+   ```bash
+   fastapi dev
+   ```
 
-> npm install
+### Frontend
 
-then run following command to run the dev server:
+1. **Navigate to the frontend directory:**
 
-> quasar dev
+   ```bash
+   cd frontend/raggi
+   ```
 
-# Settings
+2. **Install all necessary packages:**
 
-## Environments
+   ```bash
+   npm install
+   ```
 
-1. add an .env file inside **rag** folder that contains Setting for Langfuse:
+3. **Run the development server:**
 
-   - SECRET_KEY
-   - PUBLIC_KEY
-   - LANGFUSE_HOST
+   ```bash
+   npm run dev
+   ```
 
-2. add also an .env file in side **frontend/raggi** folder for the setting of the UI:
+## Settings
 
-   - API="http://ip-adress-of-api:port"
+### Environments
 
-# Features
+1. **Backend Environment Settings:**
 
-### Backend
+   Create an `.env` file inside the `rag` folder with the following settings for Langfuse:
+
+   ```env
+   SECRET_KEY=your_secret_key
+   PUBLIC_KEY=your_public_key
+   LANGFUSE_HOST=your_langfuse_host
+   ```
+
+2. **Frontend Environment Settings:**
+
+   Create an `.env` file inside the `frontend/raggi` folder with the following settings for the UI:
+
+   ```env
+   API=http://ip-address-of-api:port
+   ```
+
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request to contribute to the project.
+
+## License
+
+This project is licensed under the MIT License.
+
+## Contact
 
-- [ ] Add a digest worker for emebding documents
-- [ ] Extend user permissions
-- [ ] Add new documents to db
-- [ ] Add meta data to a document
+For any questions or inquiries, please contact.