Python API Boilerplate

A modern FastAPI REST API, ready to deploy on Light Cloud.

---

Features

• FastAPI web framework
• Automatic OpenAPI documentation
• REST API with health check endpoint
• Docker-ready for Cloud Run

API Endpoints

Method	Endpoint	Description
GET	/	Welcome message and API info
GET	/health	Health check with uptime
GET	/docs	Interactive API documentation

Local Development

# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

# Start development server
uvicorn main:app --reload --port 8080

The API will be available at http://localhost:8080

Deploy to Light Cloud

1. Create an Account

Visit console.light-cloud.com and sign up with GitHub or Google.

2. Create New Application

1. Click "New Application" in the dashboard
2. Select "Container" as the deployment type
3. Choose "Python" as the runtime

3. Connect Repository

• Option A: Fork this repository and connect it via GitHub
• Option B: Push this code to your own GitHub repository and connect it

4. Configure Settings

Light Cloud will auto-detect your settings:

Setting	Value
Port	8080
Dockerfile	Auto-detected

5. Deploy

Click "Deploy" and your API will be live in minutes!

Your API will be available at https://your-app.light-cloud.io

---

Website • Documentation • Console

Made with ☁️ by Light Cloud