Skip to content

Repository files navigation

Light Cloud

NestJS API Boilerplate

A NestJS REST API in TypeScript, ready to deploy on Light Cloud.


Features

  • NestJS 11, scaffolded with nest new
  • TypeScript with decorators and dependency injection
  • Modular architecture — controllers, providers, modules
  • Listens on $PORT, defaulting to 3000

API Endpoints

Method Endpoint Description
GET / Welcome message

Local Development

# Install dependencies
npm install

# Start development server
npm run start:dev

# Build and run for production
npm run build && npm run start:prod

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 "NestJS" 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 run start:prod

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

This starter is the output of nest new, with only the changes noted above.


WebsiteDocumentationConsole

Made with ☁️ by Light Cloud

About

NestJS starter boilerplate for Light Cloud

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages