Skip to content

README.md

Latest commit

 

History

History
58 lines (41 loc) · 1.19 KB

README.md

File metadata and controls

58 lines (41 loc) · 1.19 KB

Examples

Minimal example projects demonstrating ShipNode deployment.

Available Examples

Backend Examples

Example Framework Description
Express API Express.js REST API with health check
NestJS API NestJS TypeScript API with Prisma
Next.js App Next.js SSR full-stack app

Frontend Examples

Example Framework Description
React SPA React Router v7 Single Page Application

Try an Example

# Clone ShipNode
git clone https://github.com/devalade/shipnode.git
cd shipnode

# Explore an example
cd examples/express-api

# Install dependencies
npm install

# Run locally
npm run dev

# Deploy (after configuring shipnode.conf)
shipnode deploy

What's Included

Each example includes:

  • Complete source code
  • package.json with dependencies
  • shipnode.conf configuration
  • Step-by-step README

Quick Deploy

All examples are ready to deploy:

cd examples/<example-name>
shipnode init    # configure your server
shipnode setup   # first time only
shipnode deploy  # deploy!