first commit

DEPLOYMENT.md

@@ -1,225 +0,0 @@
-# Deployment Guide
-
-This guide will help you deploy your FastAPI backend to a free hosting service so you can share it with others.
-
-## Quick Deploy Options
-
-### Option 1: Railway (Recommended - Easiest) ⭐
-
-**Railway** is the easiest option with a free tier.
-
-#### Steps:
-
-1. **Create a Railway account:**
-   - Go to https://railway.app
-   - Sign up with GitHub (recommended) or email
-
-2. **Create a new project:**
-   - Click "New Project"
-   - Select "Deploy from GitHub repo" (if you have GitHub) OR
-   - Select "Empty Project" and upload files manually
-
-3. **If using GitHub:**
-   - Push your code to GitHub first
-   - Connect your repository
-   - Railway will auto-detect the Dockerfile
-
-4. **If uploading manually:**
-   - Click "New" → "GitHub Repo" or "Empty Project"
-   - Upload these files:
-     - `main.py`
-     - `requirements.txt`
-     - `Dockerfile`
-     - `railway.json`
-   - Railway will automatically build and deploy
-
-5. **Configure the service:**
-   - Railway will auto-detect Python
-   - Set start command: `uvicorn main:app --host 0.0.0.0 --port $PORT`
-   - Or it will use the Dockerfile automatically
-
-6. **Get your URL:**
-   - Once deployed, Railway gives you a URL like: `your-app.railway.app`
-   - Share this URL with developers!
-
-**Railway Free Tier:**
-- $5 free credit per month
-- Perfect for testing and sharing
-- Auto-deploys on git push
-
----
-
-### Option 2: Render (Also Easy)
-
-**Render** offers free hosting with easy setup.
-
-#### Steps:
-
-1. **Create a Render account:**
-   - Go to https://render.com
-   - Sign up with GitHub (recommended)
-
-2. **Create a new Web Service:**
-   - Click "New" → "Web Service"
-   - Connect your GitHub repository OR upload files
-
-3. **Configure the service:**
-   - **Name:** `fastapi-backend` (or any name)
-   - **Environment:** Python 3
-   - **Build Command:** `pip install -r requirements.txt`
-   - **Start Command:** `uvicorn main:app --host 0.0.0.0 --port $PORT`
-   - **Plan:** Free
-
-4. **Deploy:**
-   - Click "Create Web Service"
-   - Render will build and deploy automatically
-   - You'll get a URL like: `your-app.onrender.com`
-
-**Render Free Tier:**
-- Free tier available
-- Spins down after 15 minutes of inactivity (wakes up on first request)
-- Perfect for testing and sharing
-
----
-
-### Option 3: Fly.io (Good Performance)
-
-**Fly.io** offers global deployment with good performance.
-
-#### Steps:
-
-1. **Install Fly CLI:**
-   ```bash
-   # Windows (PowerShell)
-   powershell -Command "iwr https://fly.io/install.ps1 -useb | iex"
-   
-   # Or download from https://fly.io/docs/getting-started/installing-flyctl/
-   ```
-
-2. **Login:**
-   ```bash
-   fly auth login
-   ```
-
-3. **Initialize:**
-   ```bash
-   fly launch
-   ```
-   - Follow the prompts
-   - Don't deploy yet (we'll configure first)
-
-4. **Create `fly.toml`** (I'll create this for you)
-
-5. **Deploy:**
-   ```bash
-   fly deploy
-   ```
-
----
-
-## Files Needed for Deployment
-
-Make sure you have these files in your project:
-
-✅ `main.py` - Your FastAPI application  
-✅ `requirements.txt` - Python dependencies  
-✅ `Dockerfile` - For containerized deployment  
-✅ `.dockerignore` - Excludes unnecessary files  
-✅ `railway.json` - Railway configuration (optional)  
-✅ `render.yaml` - Render configuration (optional)  
-
----
-
-## After Deployment
-
-### Test Your Deployed API
-
-Once deployed, test your endpoints:
-
-**Status endpoint:**
-```bash
-curl https://your-app.railway.app/status
-```
-
-**Register endpoint:**
-```bash
-curl -X POST https://your-app.railway.app/register \
-  -H "Content-Type: application/json" \
-  -d '{"name": "John Doe", "email": "john@example.com", "age": 25}'
-```
-
-**View API docs:**
-- Swagger UI: `https://your-app.railway.app/docs`
-- ReDoc: `https://your-app.railway.app/redoc`
-
-### Share with Developers
-
-Send them:
-1. **API Base URL:** `https://your-app.railway.app`
-2. **API Documentation:** `https://your-app.railway.app/docs`
-3. **Quick Start Guide:** Share `FASTAPI_README.md`
-
----
-
-## Environment Variables (Optional)
-
-If you need to configure settings, add environment variables in your hosting platform:
-
-- `PORT` - Automatically set by hosting platform
-- `ENVIRONMENT` - Set to "production" for production mode
-
----
-
-## Troubleshooting
-
-### Common Issues:
-
-1. **Port binding error:**
-   - Make sure you're using `--host 0.0.0.0` and `--port $PORT`
-   - The `$PORT` variable is set automatically by hosting platforms
-
-2. **Build fails:**
-   - Check that `requirements.txt` has all dependencies
-   - Make sure Python version is compatible (3.8+)
-
-3. **API not accessible:**
-   - Check that the service is running (not sleeping)
-   - Verify the URL is correct
-   - Check logs in your hosting platform dashboard
-
-4. **CORS errors:**
-   - If calling from a browser, you may need to add CORS middleware
-   - Add this to `main.py` if needed:
-   ```python
-   from fastapi.middleware.cors import CORSMiddleware
-   
-   app.add_middleware(
-       CORSMiddleware,
-       allow_origins=["*"],  # In production, specify actual origins
-       allow_credentials=True,
-       allow_methods=["*"],
-       allow_headers=["*"],
-   )
-   ```
-
----
-
-## Recommended: Railway
-
-For sharing with developers, **Railway** is recommended because:
-- ✅ Easiest setup
-- ✅ Free tier with $5 credit/month
-- ✅ Auto-deploys from GitHub
-- ✅ Good performance
-- ✅ Easy to share URLs
-
----
-
-## Need Help?
-
-If you run into issues:
-1. Check the logs in your hosting platform dashboard
-2. Verify all files are uploaded correctly
-3. Make sure `requirements.txt` includes all dependencies
-4. Test locally first: `uvicorn main:app --reload`
-

Dockerfile

@@ -1,9 +1,11 @@
 # Use Python 3.11 slim image
 FROM python:3.11-slim
 
-# Set working directory
 WORKDIR /app
 
+# Create a non-root user for Hugging Face
+RUN useradd -m -u 1000 user
+
 # Copy requirements first for better caching
 COPY requirements.txt .
 
@@ -15,16 +17,14 @@ COPY main.py .
 COPY model_loader.py .
 COPY best_lung_cancer_model.joblib .
 COPY scaler.joblib .
-COPY start.sh .
 
-# Make startup script executable
-RUN chmod +x start.sh
+# Set ownership for Hugging Face user
+RUN chown -R user:user /app
 
-# Expose port (Railway/Render will set PORT env variable)
-EXPOSE 8000
+USER user
 
-# Run the application using the startup script
-# This properly handles the PORT environment variable
-# Using shell form to execute the bash script
-CMD ./start.sh
+# Hugging Face Spaces uses port 7860
+EXPOSE 7860
 
+# Run the application
+CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "7860"]

QUICK_DEPLOY.md

@@ -1,116 +0,0 @@
-# Quick Deploy Guide - Railway (5 Minutes)
-
-The fastest way to deploy your FastAPI backend and share it with developers.
-
-## Step-by-Step Instructions
-
-### 1. Create Railway Account (1 minute)
-
-1. Go to **https://railway.app**
-2. Click **"Start a New Project"**
-3. Sign up with **GitHub** (recommended) or email
-
-### 2. Deploy Your App (2 minutes)
-
-**Option A: Deploy from GitHub (Recommended)**
-
-1. **Push your code to GitHub first:**
-   ```bash
-   git init
-   git add .
-   git commit -m "Initial commit"
-   git remote add origin https://github.com/yourusername/your-repo.git
-   git push -u origin main
-   ```
-
-2. **In Railway:**
-   - Click **"New Project"**
-   - Select **"Deploy from GitHub repo"**
-   - Choose your repository
-   - Railway will auto-detect and deploy!
-
-**Option B: Deploy Manually**
-
-1. In Railway, click **"New Project"** → **"Empty Project"**
-2. Click **"New"** → **"GitHub Repo"** or **"Empty Project"**
-3. Upload these files:
-   - `main.py`
-   - `requirements.txt`
-   - `Dockerfile`
-4. Railway will automatically build and deploy
-
-### 3. Get Your URL (Instant)
-
-Once deployed, Railway gives you a URL like:
-```
-https://your-app-name.railway.app
-```
-
-**That's it!** Your API is live and ready to share! 🎉
-
-### 4. Test Your Deployed API
-
-**Status endpoint:**
-```bash
-curl https://your-app-name.railway.app/status
-```
-
-**API Documentation:**
-- Swagger UI: `https://your-app-name.railway.app/docs`
-- ReDoc: `https://your-app-name.railway.app/redoc`
-
-**Register endpoint:**
-```bash
-curl -X POST https://your-app-name.railway.app/register \
-  -H "Content-Type: application/json" \
-  -d '{"name": "John Doe", "email": "john@example.com", "age": 25}'
-```
-
-### 5. Share with Developers
-
-Send them:
-1. **API Base URL:** `https://your-app-name.railway.app`
-2. **API Docs:** `https://your-app-name.railway.app/docs`
-3. **Quick Start:** Share `FASTAPI_README.md`
-
----
-
-## What You Need
-
-Make sure these files are in your project:
-- ✅ `main.py`
-- ✅ `requirements.txt`
-- ✅ `Dockerfile`
-
----
-
-## Railway Free Tier
-
-- **$5 free credit per month**
-- Perfect for testing and sharing
-- Auto-deploys on git push
-- No credit card required for free tier
-
----
-
-## Troubleshooting
-
-**Build fails?**
-- Check that `requirements.txt` has all dependencies
-- Make sure `Dockerfile` is in the root directory
-
-**API not working?**
-- Check Railway logs (click on your service → "View Logs")
-- Verify the URL is correct
-- Make sure the service is running (not stopped)
-
-**Need help?**
-- Railway has great docs: https://docs.railway.app
-- Check `DEPLOYMENT.md` for more details
-
----
-
-## That's It!
-
-Your API is now live and shareable. Developers can access it from anywhere in the world! 🌍
-

README.md

@@ -10,27 +10,22 @@ A FastAPI-based REST API for predicting lung cancer risk based on patient sympto
 - ✅ CORS support for web applications
 - ✅ Production-ready with error handling
 
-## Quick Start
+## Hugging Face Spaces Deployment
 
-1. **Install dependencies:**
-   ```bash
-   pip install -r requirements.txt
-   ```
+This project is configured for deployment on Hugging Face Spaces using the Docker SDK.
 
-2. **Run the API:**
-   ```bash
-   uvicorn main:app --reload
-   ```
-
-3. **Access API documentation:**
-   - Swagger UI: http://localhost:8000/docs
-   - ReDoc: http://localhost:8000/redoc
+### Deploy to Hugging Face
 
-## Deployment
+1. Create a new Space on [Hugging Face](https://huggingface.co/spaces)
+2. Select **Docker** as the SDK
+3. Push this repository to your Space
+4. The API will be available at your Space URL
 
-See `QUICK_DEPLOY.md` for quick deployment instructions (Railway recommended).
+### API Endpoints
 
-For detailed deployment options, see `DEPLOYMENT.md`.
+Once deployed, access your API at:
+- **Swagger UI**: `https://your-space.hf.space/docs`
+- **ReDoc**: `https://your-space.hf.space/redoc`
 
 ## API Endpoints
 
@@ -71,6 +66,22 @@ For detailed deployment options, see `DEPLOYMENT.md`.
 }
 ```
 
+## Local Development
+
+1. **Install dependencies:**
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+2. **Run the API:**
+   ```bash
+   uvicorn main:app --reload --port 7860
+   ```
+
+3. **Access API documentation:**
+   - Swagger UI: http://localhost:7860/docs
+   - ReDoc: http://localhost:7860/redoc
+
 ## Notes
 
 - This application is for educational/research purposes only

fly.toml

@@ -1,30 +0,0 @@
-# Fly.io configuration file
-app = "your-app-name"
-primary_region = "iad"
-
-[build]
-
-[env]
-  PORT = "8000"
-
-[http]
-  internal_port = 8000
-  force_https = true
-  auto_stop_machines = true
-  auto_start_machines = true
-  min_machines_running = 0
-
-[[services]]
-  internal_port = 8000
-  protocol = "tcp"
-  processes = ["app"]
-
-  [[services.ports]]
-    port = 80
-    handlers = ["http"]
-    force_https = true
-
-  [[services.ports]]
-    port = 443
-    handlers = ["tls", "http"]
-

main.py

@@ -438,7 +438,7 @@ async def validation_exception_handler(request: Request, exc: RequestValidationE
 
 if __name__ == "__main__":
     # Get port from environment variable (for deployment) or default to 8000
-    port = int(os.environ.get("PORT", 8000))
+    port = int(os.environ.get("PORT", 7860))
     
     # --reload enables auto-reload on code changes (development only)
     reload = os.environ.get("ENVIRONMENT", "development") == "development"

railway.json

@@ -1,13 +0,0 @@
-{
-  "$schema": "https://railway.app/railway.schema.json",
-  "build": {
-    "builder": "DOCKERFILE",
-    "dockerfilePath": "Dockerfile"
-  },
-  "deploy": {
-    "startCommand": "./start.sh",
-    "restartPolicyType": "ON_FAILURE",
-    "restartPolicyMaxRetries": 10
-  }
-}
-

render.yaml

@@ -1,10 +0,0 @@
-services:
-  - type: web
-    name: fastapi-backend
-    env: python
-    buildCommand: pip install -r requirements.txt
-    startCommand: uvicorn main:app --host 0.0.0.0 --port $PORT
-    envVars:
-      - key: PYTHON_VERSION
-        value: 3.11.0
-

start.sh

@@ -1,7 +0,0 @@
-#!/bin/bash
-# Startup script for Railway deployment
-# Reads PORT from environment variable and starts uvicorn
-
-PORT=${PORT:-8000}
-uvicorn main:app --host 0.0.0.0 --port $PORT
-