[add]: app setup

README.md

@@ -0,0 +1,72 @@
+---
+
+# Setup
+
+This guide provides instructions on how to set up and run the Python application in a virtual environment.
+
+## Prerequisites
+
+Ensure you have the following installed on your system:
+- Python 3.x
+- pip (Python package installer)
+
+## Steps to Set Up the Application
+
+### 1. Clone the Repository
+
+First, clone the repository to your local machine:
+
+```bash
+git clone https://github.com/username/repository.git
+cd repository
+```
+
+### 2. Create a Virtual Environment
+
+Create a virtual environment to isolate your dependencies:
+
+```bash
+python3 -m venv venv
+```
+
+### 3. Activate the Virtual Environment
+
+Activate the virtual environment:
+
+- **For Windows:**
+  ```bash
+  venv\Scripts\activate
+  ```
+
+- **For macOS/Linux:**
+  ```bash
+  source venv/bin/activate
+  ```
+
+Once activated, you should see `(venv)` at the beginning of your terminal prompt.
+
+### 4. Install Dependencies
+
+Install the required dependencies listed in `requirements.txt`:
+
+```bash
+pip install -r requirements.txt
+```
+
+### 5. Run the Application
+
+Start the application:
+
+```bash
+flask run
+```
+
+
+
+### 6. Deactivate the Virtual Environment
+
+When you're done, deactivate the virtual environment:
+
+```bash
+deactivate
+```