Riven documentation v1

Getting Started

Riven deploys web applications from a ZIP file upload. This guide walks you through your first deployment from setup to a live URL.

- Prerequisites

- Creating an account

- Preparing your project

- Deploying your application

- Viewing your deployment

01

Prerequisites

Before you deploy, make sure you have the following:

Account

Riven account

Project

Web application source

Format

ZIP archive / GitHub repository

Riven detects your framework automatically. You do not need to configure a runtime, write a Dockerfile, or set up a build pipeline manually.

02

Creating an account

Go to app.rivendeploy.com and sign up. A 7-day free trial is available with no credit card required.

Note: After signing up, you will land on the dashboard. This is where your deployments are listed and managed.

03

Preparing your project

Riven expects a ZIP file / GitHub repository containing your project's source code. A few things to keep in mind before you upload:

Note: After signing up, you will land on the dashboard. This is where your deployments are listed and managed.

  • Include your dependency manifest at the root e.g.

    manifest
    package.json
    requirements.txt
    pubspec.yaml
    Gemfile
    any framework indexed file for based projects. Riven uses this during framework detection.

  • Do not include build output. Riven builds your project inside a container. You do not need to include dist/, .next/, or similar directories.

  • Keep the root clean. Your framework's config file (e.g.vite.config.ts, next.config.js ) should be at the root of the ZIP, not nested inside a subdirectory.

04

Deploying your application

Once your ZIP is ready, follow these steps from the Riven dashboard:

1
Upload your ZIP

Click New Deployment and select ZIP option. Then select your ZIP file. Riven extracts and stages your project automatically.

2
Framework is detected

Riven scans your project files and identifies your framework. No manual selection is needed. If detection succeeds, you will see the identified framework before the build starts.

3
Build runs in an isolated container

Riven generates a Docker environment matched to your project and starts the build inside an isolated container. Each deployment gets its own environment it does not share resources with other projects.

4
Watch live logs

Build output streams to your dashboard in real time. If a build fails, the logs show exactly where and why. You do not need to wait for the process to finish before reading output.

5
Deployment completes
Live

Build output streams to your dashboard in real time. If a build fails, the logs show exactly where and why. You do not need to wait for the process to finish before reading output.

05

Viewing your deployment

After deployment, your project URL is listed in the dashboard under your project name. Open it in a browser to confirm the application is running.

If the deployment fails, return to the build logs. Common issues include a missing dependency manifest, an unsupported framework version, or a build command that exits with a non-zero code.

Tip: Riven streams logs during the build. If you see the build stall or error early, the relevant log line is usually visible within a few seconds — you do not need to wait for a timeout.

What's next

Understand how Riven works and the features it provides.

Supported Frameworks

Which frameworks Riven supports and how to configure them

Platform Features

What features Riven supports & what you should know about