Getting Started & Setup FAQ
What setup modes are available in Vaaniz?
When you first open the app, you will be greeted with the Welcome Screen. You have two main ways to use the Vaaniz app: Offline Mode or Cloud Server Mode.
How does Offline Mode work?
- Best for: Small shops with only one checkout counter that don't need cloud syncing.
- How it works: All your inventory, sales, and customer data are saved strictly on your device's local memory.
- How to start: Simply tap "Offline Mode" on the welcome screen. You will instantly bypass login and go straight to setting up your shop details.
Pro Tip: If you ever decide to switch from a Cloud Server back to Offline Mode, the app will safely wipe the server data from your device to ensure data security.
What is the Cloud Server (BYOB) Mode?
- Best for: Growing businesses, shops with multiple staff members, or owners who want to monitor sales from their home.
- How it works: We use a Bring Your Own Backend (BYOB) model. Instead of paying us high monthly fees for server storage, you connect the app directly to your own free Google Firebase account.
- Benefits: You 100% own and control your data. You also get instant syncing across all staff devices and automatic cloud backups so you never lose your data if you break your phone.
How do I set up my free Cloud Server?
Google Firebase offers a generous "Spark Plan" (Free Tier) which provides 50,000 database reads per day—more than enough for most retail shops!
Step 1: Create a Firebase Project
- On your computer or phone browser, go to firebase.google.com and log in with your Google Account.
- Click Add Project, give your shop a name, and complete the setup.
Step 2: Enable Authentication (Logins)
- On the left menu, click Build → Authentication.
- Click Get Started.
- Under the "Sign-in method" tab, click Email/Password and enable it. Save your changes.
Step 3: Create Your Database
- On the left menu, click Build → Firestore Database.
- Click Create Database.
- Choose "Start in Production mode" and select a server location closest to you (e.g.,
asia-south1for India).
Step 4: Secure Your Database
- Inside your Firestore Database, click on the Rules tab.
- Delete whatever code is there, and paste this exact security code:
rules_version = '2';
service cloud.firestore {
match /databases/{database}/documents {
match /system/metadata {
allow read: if true;
allow create: if request.auth != null;
allow update: if request.auth.uid == resource.data.ownerUid;
}
match /{document=**} {
allow read, write: if request.auth != null;
}
}
}
- Click Publish.
Step 5: Get Your Server Config Code
- Click the Gear Icon ⚙️ next to "Project Overview" (top left) and select Project settings.
- Scroll down to the "Your apps" section and click the Web icon (
</>). - Give the app a nickname (e.g., "Shop App") and click Register.
- You will see a block of code starting with
const firebaseConfig = { ... }. Copy this entire block of code.
How do I connect the app and create my Admin account?
- Open the Vaaniz app and tap Create New Server.
- Tap Paste Config Code Here and paste the code you copied from Firebase.
- Tap Connect.
- The app will ask you to create your Owner Account. Enter your Email and create a Password.
- Tap Create Account.
⚠️ Important Security Note: The app strictly enforces a "One Admin per Server" rule. Once you claim a server, no one else can register as an admin on that database.
How do my staff members log in?
Once your server is set up, adding staff devices is incredibly easy. They do not need to go through the Firebase setup.
- Download the app on the staff device and tap Connect Server / Staff Login on the Welcome screen.
- Tap Scan QR Code.
- Simply scan the "Share Server QR" generated from the Admin's device (found in the Admin's Settings tab).
- The staff device will instantly connect to your server!
- The staff member enters the Email and Password you created for them and taps Log In.
(Note: If the camera is unavailable, staff can also tap "Enter API Keys Manually" to paste the server config code).
How do I restore lost data?
Did you buy a new phone or accidentally delete the app while using Offline Mode?
- On the Welcome Screen, tap Restore Backup File.
- Select the
.jsonbackup file you previously exported from the app. - The app will safely overwrite the local memory and restore your entire shop in seconds!