Complete Setup Guide
EssentialFollow this step-by-step guide to connect your Firebase project and start exploring your database schema.
Make sure you have:
- A Firebase project with Firestore database
- Owner or Editor permissions to create Admin SDK service accounts
- Access to Firebase Console
Create Firebase Service Account
First, you'll need to create a service account in your Firebase project. This provides secure access to your Firestore data.
1.1 Open Firebase Console
Go to the Firebase Console and select your project.
1.2 Navigate to Project Settings
Click the gear icon next to "Project Overview" and select "Project settings".
1.3 Go to Service Accounts Tab
In the project settings, click on the "Service accounts" tab.
1.4 Generate New Private Key
Scroll down to the "Admin SDK configuration snippet" section and click "Generate new private key".
The service account key provides full access to your Firebase project. Keep it secure and never commit it to version control.
1.5 Download the JSON File
Click "Generate key" in the confirmation dialog. A JSON file will be downloaded to your computer.
{
"type": "service_account",
"project_id": "your-project-id",
"private_key_id": "key-id",
"private_key": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n",
"client_email": "firebase-adminsdk-xxxxx@your-project-id.iam.gserviceaccount.com",
"client_id": "123456789",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://oauth2.googleapis.com/token",
...
}Connect Your Project in Schema Viewer
Now you'll use the service account credentials to connect your Firebase project to Schema Viewer.
2.1 Go to Your Dashboard
Navigate to your dashboard in Firebase Schema Viewer.
2.2 Click "Connect Project"
Click the "Connect Project" button to open the connection modal.
2.3 Choose Connection Method
You have two options for providing your Firebase credentials:
Upload JSON File (Recommended)
Upload the service account JSON file you downloaded from Firebase Console.
Manual Entry
Enter the credential fields manually if you prefer not to upload the file.
2.4 Fill in Project Details
Project Name: A friendly name for your project (e.g., "My E-commerce App")
Database Name: Usually "(default)" unless you're using multiple databases
2.5 Upload or Enter Credentials
Either upload your JSON file or enter the credentials manually:
Project ID: your-firebase-project-id
Client Email: firebase-adminsdk-xxxxx@your-project-id.iam.gserviceaccount.com
Private Key: -----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----The upload method is faster and less error-prone than manual entry. We recommend using the JSON file upload whenever possible.
Verify Your Connection
After submitting your credentials, your project will be added to your dashboard. Check if you can access the schema to verify the connection works.
3.1 Project Added
After clicking "Connect Project", you'll see your new project appear on the dashboard with options to:
- View Schema: Explore your database structure
- Browse Records: Search and view your data
3.2 Test the Connection
Click "View Schema" to verify your connection is working properly. If you can see your collections and their structure, the connection is successful.
3.3 Troubleshooting Connection Issues
If you can't see the schema or encounter errors, check:
- Admin SDK service account has proper permissions
- Project ID matches exactly
- Private key is complete and properly formatted
🎉 Congratulations! Your project is connected.
Now you can start exploring your Firebase database. Here's what to try next: