Getting Started

Quickstart Guide

Set up your Dreambase account and create your first project in minutes to start building applications with backend services.

Prerequisites

Ensure you have the following ready:

A GitHub account for optional integrations
Node.js {version >= 18} or Python {version >= 3.10} installed for SDK examples
Access to a code editor like VS Code

Create Your Dreambase Account

Visit Dashboard

Navigate to https://dashboard.example.com and click Sign Up.

Complete Registration

Enter your email, create a password, and verify your account via email.

Verify Email

Check your inbox and click the verification link.

Set Up Your First Project

Create a new project to organize your resources.

Create Project

In the dashboard, click Create Project and name it my-first-app.

Copy Project ID

Note your PROJECT_ID from the project settings. You'll need it for SDKs.

Enable Database Service

Go to Database in the sidebar and create your first database named main.

Configure Environment Variables

Set up your environment with the required keys.

Create a .env file:

DREAMBASE_ENDPOINT="https://api.example.com/v1"
DREAMBASE_PROJECT_ID="your-project-id-here"
DREAMBASE_API_KEY="YOUR_API_KEY"

Make Your First Database Query

Install the SDK and query your database.

// Install: npm install dreambase
import { Client, Databases, ID } from 'dreambase';

const client = new Client();
client.setEndpoint('https://api.example.com/v1').setProject('your-project-id-here');

const databases = new Databases(client);

const promise = databases.createDocument(
  'main',
  'todos',
  ID.unique(),
  {
    title: 'Learn Dreambase',
    completed: false
  }
);

promise.then(response => console.log(response), error => console.log(error));

# Install: pip install dreambase
from dreambase import Client, Databases, ID

client = Client()
client.set_endpoint('https://api.example.com/v1').set_project('your-project-id-here')

databases = Databases(client)

result = databases.create_document(
  database_id='main',
  collection_id='todos',
  document_id=ID.unique(),
  data={
    'title': 'Learn Dreambase',
    'completed': False
  }
)

print(result)

Your first document is created! Check the dashboard to view it.

Next Steps

Explore more features to build your application.

Authentication

Secure your app with user accounts and sessions.

Storage

Manage files with secure storage buckets.

Functions

Deploy serverless code for custom logic.

Was this page helpful?

Built with Documentation.AI

Last updated 1 week ago