ZinklyChat Documentation

ZinklyChat is a standalone Flutter app — chat, groups, calls, stories, VIP and a marketplace-style shop — built to talk to a ZinklySocial-compatible backend over REST and WebSockets. The distribution zip ships clean: no live server URL, no real Firebase project, no signing key. You provide those.

1. Unzip the projectExtract ZinklyChat.zip anywhere on your machine.
2. Install dependencies

   cd ZinklyChat
   flutter pub get

3. Configure your backend URL and Firebase — see Backend URL & app info and Firebase & notifications below. The app runs without Firebase configured, but pushes won't work until you do.
4. Run it

   flutter run

Everything the app needs to know about your install lives in one file: lib/constants/api_constants.dart

class ApiConstants {
  static const String baseUrl   = 'https://YourZinklyMediaURL/api/v1';
  static const String wsHost    = 'YourZinklyMediaURL';
  static const int    wsPort    = 443;
  static const String reverbKey = 'YourReverbAppKey';
  // ...
}

App identity

Also in the same file, the AppConstants class:

class AppConstants {
  static const String appName   = 'ZinklyChat';
  static const String appScheme = 'zinklymessenger'; // deep-link / URL scheme
}

Update appName if you're renaming the app. If you change appScheme, also update the matching scheme in android/app/src/main/AndroidManifest.xml and ios/Runner/Info.plist so deep links keep working.

ZinklyChat ships with placeholder Firebase config files so the project still builds out of the box. Replace them with your own before you ship, or pushes silently won't arrive (the app catches the failure and keeps working otherwise).

1. Create a Firebase projectGo to console.firebase.google.com → Add project.
2. Register your Android appPackage name: zinkly.chat (or whatever you set it to — see Branding). Download google-services.json and replace:
   android/app/google-services.json
3. Register your iOS appBundle ID: com.zinkly.zinklyMessenger (or your own). Download GoogleService-Info.plist and replace:
   ios/Runner/GoogleService-Info.plist
4. Or automate both at once

   dart pub global activate flutterfire_cli
   flutterfire configure

   This detects your Firebase project and writes both platform config files for you.
5. Enable Cloud MessagingIn the Firebase console, under Project settings → Cloud Messaging, make sure the API is enabled. No extra server key setup is needed on the client side.

How it's wired in code

• lib/main.dart calls Firebase.initializeApp() at startup, wrapped in a try/catch — a missing/placeholder config won't crash the app.
• lib/services/fcm_service.dart requests notification permission, gets the device token, and listens for foreground/background/tapped messages.
• The device token is sent to your backend via POST {baseUrl}/device-tokens (see API reference) — your backend is what actually sends the pushes through Firebase's server SDK when a new message/call/notification happens.

Every endpoint the app calls is declared in lib/constants/api_constants.dart as a relative path appended to baseUrl. Your backend must implement these routes for the matching feature to work.

Core groups

Realtime events (new messages, typing, presence) arrive over the WebSocket at wsHost, authenticated via authEndpoint (/api/v1/broadcasting/auth) — a Laravel Echo/Pusher-protocol style broadcast auth handshake.

This distribution is a plain zip, not a git remote, so "updating" means dropping a newer ZinklyChat release on top of your customized copy without losing your own settings.

1. Before updatingNote down (or diff) the files you customized: api_constants.dart, both Firebase config files, key.properties, app icon/splash assets, and any bundle-ID changes.
2. Put the project under version controlIf you haven't already, git init and commit your customized copy first — this makes re-applying your changes after an update a normal git diff/merge instead of manual copy-paste.
3. Drop in the new releaseCopy the new zip's files over yours, except the files you customized in step 1.
4. Re-run setup

   flutter pub get
   dart run build_runner build --delete-conflicting-outputs

   (the second command regenerates the *.g.dart/*.freezed.dart files if any models changed).
5. Re-testLaunch the app and confirm your backend URL and push notifications still work.

Android

1. Generate an upload keystore (once — keep this file and its password forever, every future update must be signed with it):

   keytool -genkey -v -keystore upload-keystore.jks \
     -keyalg RSA -keysize 2048 -validity 10000 -alias upload

   Put it at android/app/keystore/upload-keystore.jks.
2. Point the build at itCopy android/key.properties.example to android/key.properties and fill in the real storePassword, keyPassword, keyAlias, storeFile.
3. Build the App Bundle (what Google Play wants):

   flutter build appbundle --release

   Output: build/app/outputs/bundle/release/app-release.aab

iOS

1. Open the workspace

   open ios/Runner.xcworkspace

2. Set your teamIn Xcode → Runner target → Signing & Capabilities, select your Apple Developer Team. No team is pre-configured in the zip.
3. Build & archive

   flutter build ipa --release

   Output: build/ios/ipa/*.ipa, ready to upload via Transporter or Xcode Organizer.

Once you have a signed .aab and/or .ipa from the previous section, here's the store-side checklist.

1. Create a developer accountOne-time $25 fee at play.google.com/console.
2. Create the app listingPlay Console → Create app — name, default language, app/game, free/paid.
3. Fill in store presenceScreenshots, feature graphic, short/full description, app icon, privacy policy URL, content rating questionnaire, target audience, data safety form.
4. Upload your buildProduction (or an internal/closed testing track first) → Create new release → upload the .aab from build/app/outputs/bundle/release/.
5. Submit for reviewGoogle's review typically takes anywhere from a few hours to a few days for a first submission.

1. Enroll in the Apple Developer Program$99/year at developer.apple.com/programs.
2. Register the appApp Store Connect → My Apps → + — bundle ID must match PRODUCT_BUNDLE_IDENTIFIER in Xcode.
3. Upload the buildUse Xcode Organizer or the standalone Transporter app to upload the .ipa from build/ios/ipa/.
4. Fill in the listingScreenshots (per device size), description, keywords, privacy policy URL, App Privacy details (what data the app collects), age rating.
5. TestFlight first (recommended)Once uploaded, the build is available to TestFlight testers immediately — no review needed for internal testers.
6. Submit for reviewApple's review is typically 24–48 hours. Make sure the review notes include a working test account if login is required.