version v2

README.md

@@ -10,8 +10,9 @@ DocuPulse is a powerful document management system designed to streamline docume
 
 ### Prerequisites
 
-- Node.js (version 18 or higher)
-- npm or yarn
+- Python 3.11 or higher
+- PostgreSQL 13 or higher
+- Docker and Docker Compose (for containerized deployment)
 
 ### Installation
 
@@ -23,18 +24,50 @@ cd docupulse
 
 2. Install dependencies:
 ```bash
-npm install
-# or
-yarn install
+pip install -r requirements.txt
 ```
 
-3. Start the development server:
+3. Set up environment variables:
 ```bash
-npm run dev
-# or
-yarn dev
+# Copy example environment file
+cp .env.example .env
+
+# Set version information for local development
+python set_version.py
 ```
 
+4. Initialize the database:
+```bash
+flask db upgrade
+flask create-admin
+```
+
+5. Start the development server:
+```bash
+python app.py
+```
+
+## Version Tracking
+
+DocuPulse uses a database-only approach for version tracking:
+
+- **Environment Variables**: Version information is passed via environment variables (`APP_VERSION`, `GIT_COMMIT`, `GIT_BRANCH`, `DEPLOYED_AT`)
+- **Database Storage**: Instance version information is stored in the `instances` table
+- **API Endpoint**: Version information is available via `/api/version`
+
+### Setting Version Information
+
+For local development:
+```bash
+python set_version.py
+```
+
+For production deployments, set the following environment variables:
+- `APP_VERSION`: Application version/tag
+- `GIT_COMMIT`: Git commit hash
+- `GIT_BRANCH`: Git branch name
+- `DEPLOYED_AT`: Deployment timestamp
+
 ## Features
 
 - Document upload and management
@@ -42,6 +75,8 @@ yarn dev
 - Secure document storage
 - User authentication and authorization
 - Document version control
+- Multi-tenant instance management
+- RESTful API
 
 ## Contributing