Quick Start Guide

This guide will walk you through deploying your first Raindrop application. You’ll create a simple “Hello World” service that responds to HTTP requests.

Prerequisites

Node.js and npm installed on your system
A terminal or command prompt
A Raindrop account (sign up for beta access)

Step-by-Step Guide

1. Install Raindrop CLI

First, install the Raindrop Build tool globally using npm:

npm install -g @liquidmetal-ai/raindrop

2. Set Up Your Account

If you haven’t already, sign up for our beta. Then authenticate your CLI:

raindrop auth login

Follow the prompts in your terminal and browser to complete authentication.

3. Create Your Project

Initialize a new Raindrop project:

raindrop build init hello-world

This creates a new project directory with a raindrop.manifest file.

4. Configure Your Service

Open hello-world/raindrop.manifest and add your service configuration:

application "hello-world" {
  // create a hello world service
  service "<SERVICE NAME>" {
    domain {
      fqdn = "hello-world.<ORG ID>.lmapp.run"
    }
  }
}

5. Generate Project Files

Generate the required TypeScript files and install dependencies:

raindrop build generate
npm install

6. Implement Your Service

Navigate to src/hello-world/index.ts and update the response message:

import { services } from '@liquidmetal-ai/raindrop-framework';
import { Env } from './raindrop.gen';

export default class extends services.Service<Env> {
  async fetch(request: Request): Promise<Response> {
    return new Response('Request received');
    return new Response('Hello World!');
  }
}

7. Deploy Your Application

Create a branch and deploy your application:

raindrop build branch
raindrop build deploy

8. Test Your Deployment

Your application is now live! Test it using cURL:

curl hello-world.<ORG ID>.lmapp.run

You should see:

Hello World

What’s Next?

Explore more advances services and configurations
Learn about Raindrop’s deployment features
Check out our other guides and tutorials