msoftware/internalappstore

Manage your own internal Android App Store.

Internal App Store

Manage your own internal Android App Store.
Web app • Android app

Table of contents

• Demo
• Features
• Deploy
• Settings
• Backup
• License

Demo

A public version of the web app is hosted on public-app-store.firebaseapp.com.
The latest Android apk can also be downloaded here.

Features

• Public or private access to the store

  • User roles (anonymous or verified users)
  • Account restrictions (only admins have write access)
  📷 Screenshots

  Web	Android

• Manage multiple applications

  • Notifications for new applications
  • Description with html support
  • Shortcuts for frequent actions
  📷 Screenshots

  Web	Android

• Manage multiple versions

  • Notifications for new versions
  • Upload apks or external links
  • Changelog with html support
  • Apk files are cached
  📷 Screenshots

  Web	Android

Deploy

Requirements

• Android Studio
• Firebase account
• Firebase CLI

Configure

• Replace applicationId with your own unique id in app/build.gradle
• Create a Firebase project https://console.firebase.google.com
• Select Add Firebase to your Android app and fill in the form
• Download the config file google-services.json and move it to your Android app module root directory
• In the Firebase Authentication page, enable sign-in methods, then create your first admin user
• In the Firebase project settings, select ADD APP and Add Firebase to your web app
• When using Firebase Hosting and the CLI, Web SDK auto-configuration is enabled by default
• Verify the configuration of each module

  • Android: Store.kt

  • Web: index.js

  • Firebase Database: use your own domain

    • database-private.rules.json (read access)
    Database schema

    ├──admins
    │   └──{admin-uid}
    └──store
        ├──applications
        │   └──{application-uid}
        │       ├──name
        │       ├──packageName
        │       ├──description
        │       ├──image
        │       ├──link_{#}
        │       │   ├──name
        │       │   └──uri
        │       └──silent
        └──versions
            └──{application-uid}
                └──{version-uid}
                    ├──name
                    ├──description
                    ├──timestamp
                    ├──apkRef
                    ├──apkGeneration
                    ├──apkUrl
                    └──silent
    

  • Firebase Storage: use your own domain

    • storage-private.rules (images)
    • storage-private.rules (apks)
    Storage schema

    └──applications
        └──{application-uid}
            │──image
            └──versions
                └──{version-uid}.apk
    

Initialize

• Initialize Firebase module

  # Move to Firebase root directory
  cd firebase
  # Initialize Firebase (login popup)
  firebase login
  # Set the default Firebase project
  firebase use --add

• Add your first admin user (uid found in Firebase Authentication page)
  • Firebase Database, add admin uid

    firebase database:update /admins --data '{"<admin-uid>" : "<admin-email>"}'
    # On Windows, create a JSON file instead (unsupported JSON input)
    firebase database:update /admins update.json

  • Firebase Storage, add admin uid
    • storage-private.rules (images)
    • storage-private.rules (apks)

Deploy

• Test web app on your machine http://localhost:5000

  firebase serve

• Deploy all Firebase modules (database, storage, hosting, functions)

  firebase deploy

• Sync, build and install Android module from Android Studio

Settings

A lot of settings can be tweaked in both web and Android apps

• Store icons and titles
• Firebase auth providers
• Maximum apk size
• Admin write access
• Store visibility (private or public)
• …

Backup

• Firebase Database (Link 1, Link 2)

  // Backup
  firebase database:get / --pretty > database.json
  // Restore
  firebase database:set / database.json

• Firebase Storage (Link)

  // Backup
  gsutil -m cp -R gs://<bucket_name> .
  // Restore
  gsutil -m cp -R . gs://<bucket_name>

License

Copyright 2018 Simon Marquis

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.