DUKERSPACE

← Back to Nimman

Getting Started with Nimman

A quick start guide to get your application deployed in minutes.

Prerequisites Checklist

Before you begin, ensure you have:

  • Node.js 16+ or Bun installed
  • A Linux server (Ubuntu/Debian or CentOS/RHEL)
  • Root/sudo access on the server
  • Domain name pointing to your server's IP address (for SSL)
  • Your application code ready to deploy

Installation

1. Install Nimman

npm install -g nimman

2. Install Server Dependencies

On your server, install required tools:

# Nginx
sudo apt-get update
sudo apt-get install nginx

# Certbot (for SSL)
sudo apt-get install certbot python3-certbot-nginx

# PM2
npm install -g pm2

Quick Start (3 Steps)

Step 1: Initialize Configuration

In your project directory:

nimman init

Follow the interactive prompts. This creates nimman.yml.

Step 2: Setup Server (First Time Only)

sudo nimman setup

This configures Nginx and SSL certificates.

Step 3: Deploy

nimman deploy

Your application is now live! 🎉

What Happens During Setup?

nimman init

  • Creates nimman.yml configuration file
  • Asks about your project structure
  • Configures frontend/backend services

sudo nimman setup

  • Generates Nginx reverse proxy configuration
  • Obtains SSL certificates from Let's Encrypt
  • Configures automatic certificate renewal
  • Enables HTTPS

nimman deploy

  • Builds your services
  • Creates PM2 ecosystem configuration
  • Deploys with zero-downtime reload
  • Ensures all services are running

Verify Deployment

# Check PM2 status
pm2 status

# View logs
pm2 logs

# Visit your domain
curl https://yourdomain.com

Next Steps

Common First-Time Issues

"Nginx not found"

sudo apt-get install nginx

"Certbot not found"

sudo apt-get install certbot python3-certbot-nginx

"PM2 not found"

npm install -g pm2

SSL setup fails

  • Ensure domain points to server IP
  • Check ports 80/443 are open: sudo ufw allow 80 && sudo ufw allow 443

Need Help?

See the Full Documentation or check the Troubleshooting Guide.