> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shardcloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Node.js Hosting Guide

> Learn how to deploy Node.js applications on ShardCloud platform.

# Getting Started with Node.js Hosting

Deploy your Node.js applications on ShardWeb Cloud with minimal configuration and maximum performance.

<Info>
  ShardCloud supports both JavaScript (.js) and TypeScript (.ts) Node.js applications out of the box.
</Info>

## Prerequisites

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

<CardGroup cols={2}>
  <Card title="Required Files" icon="circle">
    Essential files for deployment
  </Card>

  <Card title="Excluded Files" icon="x">
    Files to exclude before upload
  </Card>
</CardGroup>

## 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

<Warning>
  All three files are mandatory. Missing any of these files will prevent successful deployment.
</Warning>

## Files to Exclude

Remove these files/folders before creating your deployment archive:

* node\_modules
* package-lock.json

## ShardCloud Configuration

The [.shardcloud](/config) file configures your application deployment settings.

### Configuration Example

```bash theme={null}
DISPLAY_NAME=myfirstnodeproject
DESCRIPTION=a simple node project
MAIN=index.js
MEMORY=799
VERSION=LATEST
```

<Note>
  Choose the minimum required for your application's needs.
</Note>

## Deployment Process

<Steps>
  <Step title="Prepare Application">
    Ensure all required files are present and configured
  </Step>

  <Step title="Exclude Unnecessary Files">
    Remove `__pycache__/`, `venv/`, and `.pyc` files
  </Step>

  <Step title="Create Archive">
    Zip or RAR your project
  </Step>

  <Step title="Upload via Dashboard">
    Use [ShardCloud dashboard](https://shardcloud.app/dash) to upload your archive
  </Step>

  <Step title="Deploy & Monitor">
    Application automatically builds and deploys
  </Step>
</Steps>