Configuration Guide โ
How to connect your app to your website and customize basic settings.
๐ Connect to Your Website โ
Step 1: Find Your Website URL โ
Your website URL is the address people use to visit your online store. Examples:
https://mystore.comhttps://shop.mycompany.comhttps://mystore.botble.com
Step 2: Update App Configuration โ
- Open the
.envfile in your app folder - Find this line:
API_BASE_URL=https://ecommerce-api.botble.com - Replace it with your website:
API_BASE_URL=https://your-website.com - Save the file
Step 3: Test the Connection โ
- Run your app:bash
flutter run - Try to login with an account from your website
- If it works, you're connected! ๐
โ๏ธ Basic App Settings โ
App Name โ
Change your app's name by following: App Name Guide
App Colors โ
Customize your app's colors: Theme Colors Guide
App Logo โ
Add your logo: App Logo Guide
Languages โ
Set up multiple languages: Translations Guide
๐ Security Settings โ
HTTPS Required โ
- Always use
https://in your website URL - Never use
http://for live websites - This keeps your customers' data safe
API Access โ
Make sure your website allows the app to connect:
- Contact your website developer
- Tell them you need "API access enabled"
- They'll know what this means
๐งช Testing Your Setup โ
Test These Features: โ
- โ Login with existing account
- โ Browse products
- โ Add items to cart
- โ Search for products
- โ View product details
If Something Doesn't Work: โ
- Check your website URL is correct
- Make sure your website is online
- Try logging in on your website directly
- Contact support with details
๐ Advanced Configuration โ
For more advanced setup:
- API Integration - Technical details
- Development Guide - Customization options
โ๏ธ Additional .env Keys โ
These optional keys let you fine-tune app behavior beyond the basic setup:
| Key | Values | Default | Description |
|---|---|---|---|
USE_LOCAL_HELP | true / false | false | Use local help center content instead of loading it in a WebView |
PRODUCT_IMAGE_THUMBNAIL_SIZE | small / medium / large | medium | Size of product image thumbnails throughout the app |
HOMEPAGE_PRODUCTS_PER_CATEGORY | number | 10 | Number of products displayed per category on the homepage |
ENABLE_ORDER_UPLOAD_PROOF | true / false | true | Allow customers to upload payment proof images for orders |
ENABLE_GUEST_CHECKOUT | true / false | false | Allow customers to check out without creating an account |
LICENSE_CODE | string | โ | License code used for development mode validation |
Example .env additions:
env
USE_LOCAL_HELP=false
PRODUCT_IMAGE_THUMBNAIL_SIZE=medium
HOMEPAGE_PRODUCTS_PER_CATEGORY=10
ENABLE_ORDER_UPLOAD_PROOF=true
ENABLE_GUEST_CHECKOUT=false
LICENSE_CODE=your-license-code-here๐ก Tips for Success โ
Before Going Live: โ
- Test everything thoroughly
- Try on different phones
- Ask friends to test the app
- Make sure payments work
Keep It Simple: โ
- Start with basic setup
- Add features gradually
- Test each change
- Don't change too many things at once
๐ Common Problems โ
"Connection Failed" โ
- Check your website URL
- Make sure website is online
- Contact your website developer
"Login Doesn't Work" โ
- Test login on your website first
- Check if API is enabled
- Verify user accounts exist
"No Products Show" โ
- Make sure products exist on website
- Check if products are published
- Verify categories are set up
For more help, check the Troubleshooting Guide.
