docs: update README with setup instructions and common commands

README.md

@@ -10,3 +10,97 @@ short_description: AB MPI services
 
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
+## Getting Started
+
+### Prerequisites
+- Python 3.13+
+- Docker & Docker Compose
+- Git
+
+### Setup & Installation
+
+#### Option 1: Using Docker Compose (Recommended)
+```bash
+# Navigate to the app directory
+cd app
+
+# Start the application with database
+make start
+# or
+docker-compose -f docker/docker-compose.yml up --build
+```
+
+The application will be available at `http://localhost:8000`
+
+#### Option 2: Local Development Setup
+
+1. **Install Python Dependencies**
+```bash
+pip install -r requirements.txt
+```
+
+2. **Set up Environment Variables**
+Create a `.env` file in the root directory:
+```
+SQLSERVER_HOST=localhost
+SQLSERVER_PORT=1433
+SQLSERVER_USER=sa
+SQLSERVER_PASSWORD=YourStrong!Passw0rd
+SQLSERVER_DB=aquabarrier
+SECRET_KEY=your-secret-key-here
+```
+
+3. **Start the Application**
+```bash
+# From the app directory
+uvicorn app:app --reload --host 0.0.0.0 --port 8000
+
+# for debug
+uvicorn app.app:app --reload --port 8000 --log-level debug
+```
+
+### Common Commands
+
+```bash
+# Run database migrations
+make migrate
+# or
+alembic upgrade head
+
+# Run linting
+make lint
+# or
+ruff app/
+
+# Run type checking
+make typecheck
+# or
+mypy app/
+
+# Run tests
+make test
+# or
+pytest app/tests/unit
+
+# Stop running containers
+make stop
+# or
+docker-compose -f docker/docker-compose.yml down
+```
+
+### Development Workflow
+
+1. **Access API Documentation**
+   - OpenAPI (Swagger): `http://localhost:8000/docs`
+   - ReDoc: `http://localhost:8000/redoc`
+
+2. **Database Connection**
+   - Host: `localhost`
+   - Port: `31433` (Docker) or `1433` (Local MSSQL)
+   - Database: `aquabarrier`
+   - Username: `sa`
+   - Password: `YourStrong!Passw0rd`
+
+3. **Logs**
+   - Docker logs: `docker-compose -f docker/docker-compose.yml logs -f app`
+