Quick Start Guide

Get your first project running in under 10 minutes.

Prerequisites

Before you begin, you'll need:

• A DevOur account (sign up at the login page)
• At least one project credit (see Credits & Billing)
• A Firebase account for authentication
• A Stripe account for payments
• A Resend account for emails
• Docker installed on your machine
• The DevOur CLI, to build your bundle (CLI Setup)

Step 1: Create a New Project

1. Log in to your DevOur dashboard
2. On the Projects page, click Add
3. Enter a name and optional description
4. Click Create

For detailed instructions, see Creating a Project.

Step 2: Configure Firebase

Firebase handles user authentication in your generated platform.

1. Create a project in the Firebase Console
2. Register a web app and copy the configuration values
3. Enable Email/Password authentication
4. Generate a service account JSON file
5. In DevOur, open your project's Settings, go to the Integrations tab, and enter the Firebase values in the Firebase section
6. Upload the service account file

For step-by-step instructions, see Firebase Setup.

Step 3: Configure Stripe

Stripe handles subscriptions and payments.

1. Get your API keys from the Stripe Dashboard
2. In DevOur, open Settings, go to the Integrations tab, and enter your keys in the Stripe section
3. Go to the Products page and create your subscription tiers
4. Set each product's price, features, and max usage

For step-by-step instructions, see Stripe Setup and Creating Products.

Step 4: Configure Resend

Resend handles transactional emails like password resets and email verification.

1. Create an account at Resend
2. Generate an API key
3. Optionally configure a custom sending domain for better deliverability
4. In DevOur, open Settings, go to the Integrations tab, and enter your Resend API key and sender email in the Resend section

For step-by-step instructions, see Resend Setup.

Step 5: Create a Version and Build Its Bundle

Versions capture snapshots of your project configuration.

1. On your project page, enter a version number such as 1.0.0 in Create a new version with the current project settings
2. Click Create
3. Click Create Bundle on the new version and wait for it to finish

For more on versioning, see Creating Versions.

Step 6: Download and Run

1. On your project page, click Download next to the version
2. Extract the ZIP file
3. Run the project with Docker:

docker compose up -d --force-recreate --build

4. Open http://localhost:3009 in your browser

For detailed instructions and troubleshooting, see Downloading and Running Your Project.

What's Next?

• Project Settings - Customize colors, the theme, and more
• Locales & Translations - Translate your platform
• Creating Projects from CLI - Configure everything from a file