Quick Get Started Guide to Lotus

From CjWiki
Jump to: navigation, search

This documentation guides you through setting up Lotus app for your users.

Get the Lotus App

Lotus app comes with two stage download process.

  1. . Download the Lotus component
  2. . Build, customize and download Lotus Android App

Setup Lotus Joomla! component

Setting up Joomla! component is like any other Joomla! extension.

Download and install

Make sure you have active Lotus membership on corejoomla.com

Go to downloads page on corejoomla.com and download Lotus Joomla! component. This component act as a service provided to the Android clients. Installation is straight forward, please see below documentation about installing a Joomla! component.

https://docs.joomla.org/Installing_an_extension

Setup Firebase Project

  1. . Go to https://console.firebase.google.com and login with your Google ID.
  2. . Create a new project for your app
  3. . Once you create the app, it will allow you to download google-services.json file. Keep this file safe in your computer.
  4. . Go to your project settings and note down "Project ID" value from General tab and "Server key" value from Cloud Messaging tab

Configure Joomla! component Options

  1. Go to Components -> Lotus -> Click on Options button on toolbar
  2. Enter Project ID and Server Key values from previous step into Lotus Component Options
  3. Configure other options as per your requirements
  4. Enable/Disable integrations for the other components such as CjForum, Community Answers etc.
  5. Save options

Setup Android App

Setting up Android app involves creating APK file and uploading it to Google Play Store so that your users can download it and update it from Android phones.

Create, Customize and Download APK file

  1. Login to corejoomla.com with your user id and password
  2. Go to Account -> My Apps menu from main menu
  3. Click on New App button to start creating new App

See below documentation to learn more about customizing the app:

Creating Lotus Android App

  1. Make sure to upload google-services.json file in the APP VALUES tab of customize app page.
  2. Once you customize the app, save the app settings. You will be redirected back to the My Apps page.
  3. Click on Build button on your app row
  4. The app will start building on the server.
  5. Refresh the page after 15 minutes, you should see the download button enabled and build button back to normal from waiting state.
  6. Click on download link to download your app

Sign your app

Google do not accept any app which is not digitally signed. So it is very important to remember the following points.

  1. Create and store digital signature key in a secured location. Without this signature file you will not be able to update your app on Google Play Store in the future. It is impossible to recreate the signature file if you lost it.
  2. Never share the signature to anyone including us.

Please follow the below guide to know more about creating signature key file and sign your app.

http://wiki.corejoomla.com/Signing_your_Android_app_to_publish_on_Play_Store

Upload APK file to Android Play Store

Google Developer Console is your one stop shop to manage all your Android Apps. Android mobile users will be able to download and update apps from Play Store directly and you need not store the app on your servers.

  1. Signup for developer account on Google Play Store: https://play.google.com/apps/publish
  2. You need to pay small fee to get a developer account at Google
  3. After login to developer console, create a new app and customize description and other information shows to your users
  4. Upload signed APK file on developer console.
  5. Google will review and approve your app within a couple of business days.

Congratulations, your site is now goes mobile.