Skip to content

README.md

Latest commit

 

History

History
89 lines (59 loc) · 2.05 KB

README.md

File metadata and controls

89 lines (59 loc) · 2.05 KB
Raw

Light Cloud

Fastify API Boilerplate

A Fastify REST API with structured logging, ready to deploy on Light Cloud.

Features

  • Fastify 5 with structured logging
  • Binds 0.0.0.0 rather than Fastify's localhost default, which is unreachable from outside the container
  • REST API with health check endpoint
  • Listens on $PORT, defaulting to 3000

API Endpoints

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

Local Development

# Install dependencies
npm install

# Start the server
npm start

# Start with file watching
npm run dev

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

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 "Fastify" as the framework

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, but you can verify:

Setting Value
Port 3000
Start Command npm start

5. Deploy

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

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

Learn More

Website • Documentation • Console

Made with ☁️ by Light Cloud