Quickstart

Initialize a new project using our CLI tool. This sets up the necessary configuration and scaffold.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js 18+: We recommend the latest LTS version.
• Git: Required for project versioning.
• Nept Account: You can sign up here for free.

Step 1: Install the CLI

The Nept CLI is the primary way to interact with our platform. Install it globally via npm:

npm install -g nept-cli

Step 2: Authenticate

Log in to your account. This command will open your browser to authorize the session.

nept login

Step 3: Initialize Project

Navigate to the directory where you want to create your project and run the init command. You will be prompted to choose a starter template.

nept init my-app

• Next.js: Full-stack React framework with SSR and API routes.
• React (Vite): Fast, client-side SPA with minimal configuration.
• Vue.js: The progressive JavaScript framework.
• SvelteKit: Web development for the rest of us.

Step 4: Deploy

Enter your project directory and deploy to the production environment.

cd my-app
nept deploy --prod

Your project is now live! You'll receive a unique .nept.cloud URL for your deployment.

Troubleshooting

"Permission Denied" Errors

If you encounter permission issues during installation, try running with sudo or check your npm permissions.

Build Failures

Check the logs using nept logs to identify the cause. Common issues include missing dependencies or incorrect build scripts in package.json.