Fin Sync Pro

A personal-finance mobile app with a Laravel backend and admin panel. This guide takes you from the downloaded files to a published app.

1. Overview

The package has two parts:

Features: income and expenses with categories, monthly budgets, savings goals, reminders, shared events with expense splitting, reports and charts, push notifications, Google sign-in, optional AdMob ads, and a points system (spin wheel, rewarded ads, unlockable features).

Do things in this order: install the backend (section 3), set up Firebase (section 5), point the app at your backend (section 6), then rebrand (section 7).

1.1 What's in the download

FolderContents
documentation/This guide.
main/backend-and-admin-panel/The Laravel API, the admin panel and the web installer. Install this first.
main/mobile-app/The Flutter app for Android and iOS.
licensing/License notes and credits for every third-party package, font and library.

1.2 The app

Home
Home
Activity
Activity
Add an expense
Add an expense
Monthly budgets
Monthly budgets
Savings goal
Savings goal
Shared event
Shared event

2. Requirements

Backend server

Your computer (for the app)

3. Install the backend

3.1 Upload and prepare

  1. Upload the backend-and-admin-panel folder to your server.
  2. Point your domain's document root at backend-and-admin-panel/public. Do not expose the folder above it.
  3. Install the PHP packages, from inside backend-and-admin-panel:
    composer install --no-dev --optimize-autoloader
  4. Make these writable by the web server user: storage, bootstrap/cache, public, and the backend-and-admin-panel folder itself (the installer creates the .env file there). Do not create .env yourself.
    chmod -R ug+rwX storage bootstrap/cache public
    chmod ug+w .
  5. Create an empty MySQL database and a user that can use it. The installer refuses a database that already has tables, so it never overwrites data.
Using cPanel shared hosting? Follow the screenshot walkthrough in section 3.2 (it covers the upload), then continue with 3.3.

3.2 Walkthrough: shared hosting with cPanel

Follow this if your host gives you cPanel. The screens can look slightly different on your host, but the names are the same. Replace yourdomain.com with your own domain.

Step 1. Create the database

On the cPanel home page, open MySQL® Database Wizard in the Databases section.

Open MySQL Database Wizard
Open MySQL Database Wizard

Type a database name and press Next Step. cPanel adds your account name in front, so the full name looks like account_dbname. Write down the full name.

Create the database
Create the database

Step 2. Create the database user

Choose a user name and a strong password (the Password Generator button makes one). Press Create User and write down the full user name and the password: the installer asks for both. Do not use root; shared hosting does not allow it.

Create the database user
Create the database user

On the next screen tick ALL PRIVILEGES and press Make Changes, then Next Step.

Give the user all privileges
Give the user all privileges

Step 3. Choose the PHP version

Open MultiPHP Manager (or Select PHP Version), choose your domain and set PHP 8.3 or newer. In Select PHP Version, also tick the extensions listed in section 2 (curl, dom, fileinfo, mbstring, openssl, pdo_mysql, sodium, tokenizer, xmlwriter). The installer's first step shows anything still missing.

Step 4. Upload the files

On your computer, open main/backend-and-admin-panel from the download and make a ZIP of what is inside it (the app, public and other folders, not the folder above). Then go back to the cPanel home page and open File Manager.

Open File Manager
Open File Manager

Open the folder for your domain (for a main domain this is usually public_html; for an add-on domain or subdomain it is the folder you chose when you created it). Press Upload and add your ZIP.

Upload the ZIP file
Upload the ZIP file

Right-click the uploaded file and choose Extract.

Open the Extract menu
Open the Extract menu

Confirm the folder and press Extract Files. When it finishes, delete the ZIP file.

Extract the files
Extract the files

If the files ended up inside an extra folder, open it, press Select All, then Move them up to the domain folder.

Step 5. Install the PHP packages

The download has no vendor folder. Use one of these:

Step 6. Point the domain at the public folder

The web address must open the public folder, not the folder above it. In cPanel open Domains, press Manage next to your domain and set the Document Root to the public folder (for example public_html/public). If your cPanel does not let you change the document root, ask your host to do it, or create a subdomain whose document root is that folder.

Why this matters. Everything outside public holds your settings, code and database details. If the document root is the project folder, visitors could download them.

Step 7. Run the installer and set up the cron job

  1. Make sure storage, bootstrap/cache and public are writable (in File Manager: right-click, Change Permissions, 775). Do not create .env yourself.
  2. Turn on HTTPS for the domain (SSL/TLS Status, Run AutoSSL).
  3. Open https://yourdomain.com/install/ and follow section 3.3. Enter the full database name, user name and password from Steps 1 and 2, with host localhost.
  4. Open Cron Jobs, choose Once Per Minute and add this command (use the PHP path your cron page shows as an example, such as /usr/local/bin/ea-php83, and the real path to your folder):
    /usr/local/bin/ea-php83 /home/youraccount/yourdomain.com/artisan schedule:run >> /dev/null 2>&1

3.3 Run the web installer

Open https://your-domain/install/ (opening https://your-domain before installing takes you there too) and follow the six steps:

StepWhat to do
1. RequirementsThe installer checks PHP 8.3+, the PHP extensions, the Composer packages (vendor/) and the folders it must write to. Fix anything marked red (each line says how), then press Check again.
2. DatabaseEnter the host (usually localhost), port, database name, user and password. The installer tests the connection and checks that the database is empty.
3. AppEnter your app name, your site address and a brand color. These appear in the admin panel and the mobile app; you can change them later in Settings, Branding. Choose Live site for a real server.
4. AdminEnter your name, email and a password of at least 8 characters. This is the only admin account; there is no default one.
5. InstallCheck the summary and press Install now. The installer writes .env (with a new application key and APP_DEBUG=false), creates the tables, applies the latest updates, saves your branding and admin account, and links public storage.
6. DonePress Open the admin panel and sign in with the email and password from step 4.

No purchase code is needed, and the installer makes no outside web requests.

Step 1: server check
Step 1: server check
Step 2: database
Step 2: database
Step 3: app name, address and color
Step 3: app name, address and color
Step 4: your admin account
Step 4: your admin account
Step 5: install
Step 5: install
Step 6: done
Step 6: done
When it finishes, the installer locks itself with storage/installed.lock. To install again, delete that file and .env, and use an empty database. After installing you can delete the public/install folder.
Installing over SSH instead: copy .env.example to .env, fill in the database details and set APP_INSTALLED=true. Then, in the backend folder, run php artisan key:generate, php artisan migrate --force, php artisan db:seed --class=DefaultDataSeeder --force and php artisan storage:link. Create your admin with php artisan tinker, or add a row to the users table with a bcrypt password, and set your app name and brand color in the admin panel under Settings, Branding.
Never leave debug on. Keep APP_DEBUG=false on a live server, because debug pages reveal secrets.

3.4 Your API address

The mobile app talks to https://your-domain/api. You will enter this in section 6.

4. After installing

4.1 Cron job (required for notifications)

Add one cron entry that runs Laravel's scheduler every minute. Replace the path with yours:

* * * * * cd /path/to/backend-and-admin-panel && php artisan schedule:run >> /dev/null 2>&1

Without it no reminders or daily notifications are sent. The jobs and their times are listed in section 12.

4.2 Firebase service account (required for push and Google sign-in)

The backend verifies Google sign-in tokens and sends push notifications with a Firebase service-account key. Create it as described in section 5.3, then upload it in the admin panel: Settings, Integrations, Firebase, Upload key. The panel checks that it is a service-account key, stores it outside the public folder (storage/app/firebase/), and shows the project it belongs to.

If you prefer, keep the file anywhere outside the web root and set its full path in .env instead. An uploaded key takes priority.

FIREBASE_CREDENTIALS=/full/path/to/your-key.json
This file is a secret. Never commit it, never put it in public, and never share it. If it leaks, delete the key in the Firebase console and create a new one.

4.3 Mail settings

In the admin panel open Settings, System settings, Email and fill in the mail host, port, encryption, user name, password, driver and from address. The password-reset email uses these.

4.4 Other settings

4.5 Sample data and a public demo (optional)

To fill a test site with sample data, run this on the server, from the backend folder:

php artisan db:seed --class=DemoSeeder

It creates the app user [email protected] (user ID demo, password demo1234, or the value of DEMO_USER_PASSWORD in .env) with four months of income and spending, budgets, reminders, savings goals and a shared event. Running it again resets that data. On a live site the seeder refuses to run unless DEMO_MODE=true is set in .env.

To run a public demo for your own customers, also set these in .env:

DEMO_MODE=true
DEMO_ADMIN_PASSWORD=choose-a-password-you-are-happy-to-show

Then run the seeder once and keep the cron job from 4.1 running. In demo mode:

The sign-in page in demo mode, with the demo login and a Fill in button
The sign-in page in demo mode, with the demo login and a Fill in button
Never turn on DEMO_MODE on a real site: it makes the admin panel read-only and shows a login on the sign-in page.

5. Firebase

Create your own Firebase project. Do not ship the sample project's files.

5.1 Create the project and apps

  1. In the Firebase console create a project.
  2. Add an Android app using your Android package id, and an iOS app using your iOS bundle id (see section 7 for where to choose them).
  3. Download google-services.json into mobile-app/android/app/ and GoogleService-Info.plist into mobile-app/ios/Runner/, replacing the sample files.
  4. Regenerate the Dart options file from inside mobile-app:
    dart pub global activate flutterfire_cli
    flutterfire configure
    This rewrites lib/firebase_options.dart.

5.2 Turn on Google sign-in

  1. In Firebase open Authentication, then Sign-in method, and enable Google.
  2. Add your Android app's SHA-1 and SHA-256 fingerprints in Project settings (debug and release keys).
  3. Copy the Web client ID shown under the Google provider and put it in mobile-app/lib/utils/constant.dart as Constants.clientId.

5.3 Create the backend key

  1. In Firebase open Project settings, then Service accounts, and choose Generate new private key.
  2. Upload the downloaded file in Settings, Integrations (section 4.2).

5.4 Push notifications on iOS

Upload your APNs authentication key in Firebase under Project settings, Cloud Messaging, and enable the Push Notifications and Background Modes (remote notifications) capabilities in Xcode.

6. Run the app

Point the app at your own server before you publish. Out of the box the app connects to the public demo server (https://finsyncpro.shahriarsagor.com/api), so it runs at once with a plain flutter run. Before you build for your customers, set your own API address as shown below, or the app will keep talking to the demo.
  1. From inside mobile-app fetch the packages:
    flutter pub get
  2. Create your settings file:
    cp config/app.example.json config/app.json
    Edit it so it holds your API address:
    { "API_BASE_URL": "https://your-domain/api" }
    config/app.json is ignored by git, so your address is not committed.
  3. Run:
    flutter run --dart-define-from-file=config/app.json
    Without the option the app uses the demo address from defaultApiBaseUrl in lib/utils/app_config.dart; with it, your config/app.json address takes priority. You can also type your own address into defaultApiBaseUrl and run without any option. In Android Studio pick the Fin Sync Pro run configuration, and in VS Code the Fin Sync Pro launch entry. Both already add this option.

Try the app before your server is ready

You do not need to set anything to try it: with no address given, the app uses the demo server. Sign in with [email protected] and demo1234. The demo data is restored every hour and the demo may be offline at times. An app that points at the demo server will not work for your users, so set your own address before you publish.

API address rules

7. Rebrand

From the admin panel, no rebuild needed: open Settings, Branding to set the app name, brand color and logo (square PNG, JPG or WebP). The admin panel changes at once, and the mobile app picks them up the next time it opens. The panel refuses colors too light for white button text.

In the app project, needs a new build: the home-screen icon, splash screen, the name under the icon, package IDs and the Firebase and AdMob app files. Change every item below before publishing. The values currently in the project belong to the sample app.

WhatWhereNotes
App nameandroid/app/src/main/AndroidManifest.xml (android:label); ios/Runner/Info.plist (CFBundleDisplayName, CFBundleName)Currently "Fin Sync Pro".
Android package idandroid/app/build.gradle (applicationId)Currently com.codercamp.smartfintechmanager. Choose yours before creating the Firebase app, and never change it after publishing.
iOS bundle idXcode, Runner target, Signing and CapabilitiesMatch it to the Firebase iOS app.
Firebase filesandroid/app/google-services.json, ios/Runner/GoogleService-Info.plist, lib/firebase_options.dartSection 5.
Google web client IDlib/utils/constant.dart (Constants.clientId)Section 5.2.
AdMob app IDsAndroidManifest.xml (com.google.android.gms.ads.APPLICATION_ID); Info.plist (GADApplicationIdentifier)Currently Google's public test IDs.
Brand color, name and logo inside the appAdmin panel, Settings, BrandingNo rebuild. The app reads them from the server and remembers them. The built-in default is BrandTheme.defaultColor in lib/utils/brand_theme.dart (Royal violet #6D28D9); the icon and splash use that default until you regenerate them.
Logo, icon and splashlib/common/brand_mark.dart, then run the commands below.See the box below.
iOS tracking textios/Runner/Info.plist (NSUserTrackingUsageDescription)Shown by the iOS tracking prompt.
Backend nameAdmin panel, System settings, App Name

Logo, icon and splash screen

The logo is drawn in code (lib/common/brand_mark.dart) in your brand colors, so it stays sharp at every size. After you change the colors or the mark, render the icon and splash images, then generate the platform files:

flutter test tool/brand_assets_test.dart
dart run flutter_launcher_icons
dart run flutter_native_splash:create

To use your own logo artwork instead, replace the three images in assets/branding/ (1024×1024 PNG: icon_1024.png on a solid background, icon_foreground.png and logo_mark.png on transparent) and run only the last two commands. Also set adaptive_icon_background in pubspec.yaml to your color.

The icon tool can rewrite ios/Runner.xcodeproj/project.pbxproj and reformat ios/Runner/Info.plist. If that happens, restore those two files with git checkout (or from a backup); the icons themselves are already generated.

8. Ads and consent

9. Release builds

Android

  1. Create an upload keystore. Run this from mobile-app, answer the questions and choose a password (keep the file and its passwords safe and out of git):
    keytool -genkey -v -keystore android/upload-keystore.jks -keyalg RSA -keysize 2048 -validity 10000 -alias upload
  2. Copy android/key.properties.example to android/key.properties and fill in the same details. The default storeFile=../upload-keystore.jks matches the command above. The build reads this file on its own; without it, a release build is signed with the debug key and cannot go on Google Play. See also the Flutter Android guide.
  3. Build the bundle for Google Play:
    flutter build appbundle --dart-define-from-file=config/app.json

iOS

  1. Open ios/Runner.xcworkspace in Xcode and set your team and bundle id.
  2. Build and archive:
    flutter build ipa --dart-define-from-file=config/app.json
    then upload with Xcode's Organizer, following the Flutter iOS guide.

Always pass --dart-define-from-file=config/app.json to release builds (or set defaultApiBaseUrl), or the app is built with the demo server address.

10. Store requirements

11. Admin panel

MenuWhat it does
OverviewSign-ups today and this week, total, active and inactive clients, a 31-day sign-up chart, and today's spin-wheel activity.
Settings, System settingsApp name; spin wheel spins per day; minutes between rewarded ads; points per ad view and per referral; the Google sign-in switch; mail settings; and for Reminders, Savings Goals and Expense Split a premium switch (off means free for everyone), the points needed to unlock, and the unlock length in days.
Settings, AdsAdMob on/off, publisher ID and ad unit IDs (section 8).
Settings, BrandingApp name, brand color and logo for the admin panel and the app.
Settings, IntegrationsUpload the Firebase service-account key; record your AdMob app IDs.
Settings, Pages and policiesPrivacy policy and account-deletion page text.
Client, All clientsRegistered users; activate or deactivate an account.
Settings, Spin wheelThe point values and colors on the wheel.
Notification, Send notificationSend a message with a title and body to all users.
Settings, Countries and currencyThe country and currency list shown at registration.
Overview
Overview
Settings, Branding
Settings, Branding
Settings, Integrations
Settings, Integrations
Notification, Send notification
Notification, Send notification
Settings, Ads
Settings, Ads

12. Scheduled jobs

These run from the cron entry in section 4.1. Times are in UTC, the backend's timezone setting (config/app.php).

Time (UTC)Job
10:00 dailyEvent reminders
12:00 dailyTotal budget reminder
18:00 dailyBudget category reminder
20:00 dailySavings goal reminder
21:00 dailyDaily reminder
22:00 dailyDaily notification
00:00 on the 2nd of each monthCopies the previous month's budgets to the new month

List them any time with php artisan schedule:list.

13. Troubleshooting

You seeCause and fix
The app shows "Set your server address"The address in config/app.json or defaultApiBaseUrl is not a full web address. The message on the screen names the problem and shows a corrected example (section 6).
The app opens but every screen fails to loadAPI_BASE_URL points at a server that is not running or is not your backend. Check that the address opens in a browser.
config.invalid_base_url at startupThe address is empty or not a full web address. Use https://your-domain/api.
config.insecure_base_url at startupA release build was given http://. Use https://.
Installer: "This database already has tables"Create a new, empty database (or empty this one in phpMyAdmin), then go back to step 2.
Installer: ".env can be written" is redGive the web server user write access to the backend-and-admin-panel folder (section 3.1), or create an empty .env file with permission 666, then press Check again.
Sign-up shows no countries, or ads and rewards do nothingThe default settings and countries are missing from the database. Run php artisan db:seed --class=DefaultDataSeeder --force on the server. It only adds what is missing and keeps your data.
Installer: "Already installed"The installer is locked. To reinstall, delete storage/installed.lock and .env (see section 3.3).
Blank page or 500 error on the backendCheck storage/logs/laravel.log, and that storage and bootstrap/cache are writable.
Profile photos do not showRun php artisan storage:link and make sure public/storage exists.
Google sign-in failsThe Google provider is off in Firebase Authentication, the SHA fingerprints are missing, or Constants.clientId is not your web client ID.
Google sign-in: "Invalid or expired sign-in token"The backend cannot read the service-account key. Check storage/app/firebase/firebase-adminsdk.json or FIREBASE_CREDENTIALS, and that it belongs to the same Firebase project as the app.
No Firebase App '[DEFAULT]' has been createdfirebase_options.dart or the Firebase files do not match your package id. Repeat section 5.1.
No push notificationsThe cron entry is missing (section 4.1), the service-account key is missing, or on iOS the APNs key was not uploaded.
No ads appearConsent was declined or unresolved, ads are off on the Ads page, or the ad unit IDs are wrong.
Watching a rewarded ad gives no pointsServer-side verification is on but the callback URL is not set in AdMob (section 8), or the cooldown between ads has not finished.

14. Credits and licenses

AI disclosure

AI tools were used to create this item. In detail:

PartAI used?What was used
Source code (app and backend)YesWritten with the help of Claude (Anthropic) as a coding assistant, then reviewed, tested and run by the author.
This documentationYesDrafted with the help of Claude (Anthropic) and checked by the author against the shipped code.
Graphics and listing imagesYesThe layouts of the listing images were written with the help of Claude (Anthropic). The app and admin screens in them are real screenshots with fictional sample data.
Explainer video (not part of the download)YesBuilt from code with Remotion. The narration comes from the open-source Kokoro text-to-speech model, and the music is generated by a script.

No AI service runs inside the product: the app and the backend never send data to an AI provider, and no AI account or key is needed.