Skip to main content

Getting Started with Node.js Hosting

Deploy your Node.js applications on ShardWeb Cloud with minimal configuration and maximum performance.
ShardCloud supports both JavaScript (.js) and TypeScript (.ts) Node.js applications out of the box.

Prerequisites

Before uploading your Node.js application, ensure you have the following project structure ready.

Required Files

Essential files for deployment

Excluded Files

Files to exclude before upload

Required Files

Your Node.js application must include these three essential files:

1. Entry Point File

  • File: index.js or index.ts
  • Purpose: Main application entry point
  • Requirements: Must export or start your server

2. Package Configuration

  • File: package.json
  • Purpose: Defines dependencies and project metadata
  • Requirements: Valid JSON with dependencies listed

3. ShardCloud Configuration

  • File: .shardcloud
  • Purpose: Platform-specific deployment settings
  • Requirements: Plain text configuration file
All three files are mandatory. Missing any of these files will prevent successful deployment.

Files to Exclude

Remove these files/folders before creating your deployment archive:
  • node_modules
  • package-lock.json

ShardCloud Configuration

The .shardcloud file configures your application deployment settings.

Configuration Example

DISPLAY_NAME=myfirstnodeproject
DESCRIPTION=a simple node project
MAIN=index.js
MEMORY=799
VERSION=LATEST
Choose the minimum required for your application’s needs.

Deployment Process

1

Prepare Application

Ensure all required files are present and configured
2

Exclude Unnecessary Files

Remove __pycache__/, venv/, and .pyc files
3

Create Archive

Zip or RAR your project
4

Upload via Dashboard

Use ShardCloud dashboard to upload your archive
5

Deploy & Monitor

Application automatically builds and deploys
I