Server-Side API

NukeBase is a managed service that provides instant provisioning and deployment. Your project structure includes:

• server/database.js: The core database engine
• server/data/: Your database directory (a tree of data.json files joined by $split markers — see Storage & Backups)
• server/rules.js: Security rules configuration
• server/app.js: Your application configuration file
• public/: Frontend files (index.html, css, js, etc.)
• sys/deploy.js: Deploy program
• sys/config.json: Deployment configuration
• node_modules/: Dependencies (auto-generated)
• package.json: NPM package configuration
• package-lock.json: Dependency lock file

Setup and Initialization

Getting started with NukeBase is simple - provision your project through our managed service and start developing immediately.

Step 1: Create Your Project

Getting started is as simple as visiting a URL in your browser:

1. Visit: https://nukebase.com/createuser
2. Fill in your project details (username, project name)
3. Click "Provision & Download"
4. Your project zip will download automatically

Step 2: Local Development Setup

After provisioning, extract the downloaded zip file and set up your VS Code workspace:

# 1. Extract the downloaded project zip file
# Right-click the .zip file and select "Extract All"

# 2. Open VS Code
# File → Add Folder to Workspace → Select your extracted project folder

# 3. Open Terminal in VS Code
# Terminal → New Terminal → Select Folder As Directory

# 4. Install NukeBase CLI globally
npm install -g

# 5. Install NukeBase NPM Packages
npm install

# 6. Now you can use NukeBase commands:
nukebase push   # Push local changes to live server
nukebase pull   # Pull live server changes to local

Step 3: Start Developing

Your project structure is ready to use:

• /public: Edit your frontend files (HTML, CSS, JavaScript)
• /server/app.js: Configure backend logic, domains, and database triggers
• /server/rules.js: Define security rules for data access
• /server/data/: Your real-time database directory (auto-synced)

Basic Server Configuration Structure

Your server/app.js file uses a module export pattern that provides access to all NukeBase APIs:

module.exports = ({
  addDbTrigger,
  addCallable,
  addConnectionTrigger,
  get,
  set,
  update,
  remove,
  query,
  generateRequestId,
  data,
  addDomain,
  startDB,
  checkAuth,
  withBody,
  hashToken
}) => {

  const path = require("path");

  const nukebase = addDomain({
    authPath: ["users"],
    host: "127.0.0.1", // optional - defaults to "127.0.0.1"
    port: 3000 // optional - defaults to 3000
  });

  nukebase.app.serveStatic("/*", path.join(__dirname, "../public"),
    (res, req) => { return true; }
  );

  startDB(nukebase);
}

Available Exports

Your app.js module receives the following functions and objects: