Welcome to the ShipNode documentation. Here you'll find detailed guides and reference documentation for deploying Node.js applications.
- Installation - Install ShipNode on your machine
- Quick Start - Deploy your first app in 5 minutes
- First Deploy - Complete tutorial
- Deploy Backends - Express, NestJS, Fastify, etc.
- Deploy Frontends - React, Vue, Svelte SPAs
- Zero-Downtime Deployments - How atomic deployments work
- Rollbacks - Revert to previous releases
- Configuration - shipnode.conf reference
- Multi-Environment - Staging and production
- Custom Templates - Customize PM2 and Caddy
- Hooks - Pre/post deploy scripts
- Health Checks - Configure health check endpoints
- Environment Variables - Managing .env files
- Security - Server hardening
- CI/CD - GitHub Actions integration
- Commands - All ShipNode commands
- Frameworks - Supported frameworks
- Package Managers - npm, yarn, pnpm, bun
- Troubleshooting - Common issues
- Configuration Reference - All config options
- Examples Overview - Example projects
- Express API
- NestJS API
- Next.js App
- React SPA
- Architecture - Internal module design
- Contributing - Development guide
- Distribution - Release system
| Resource | Description |
|---|---|
| README | Main README with quick start |
| CHANGELOG | Release history |
| GitHub | Repository |