kolapsis/androidgenerator-bundle

This bundle provides Android application generator based on your project.Resulting Android application contain account, contentprovider, sync service and adapter for perfect Android integration

dev-master / 1.0.x-dev 2020-04-22 19:53 UTC

Requires

• php: >=5.5.9
• doctrine/doctrine-bundle: ^1.6
• doctrine/orm: ^2.5
• friendsofsymfony/user-bundle: ^2.0@dev
• jms/serializer-bundle: ^1.1
• sensio/framework-extra-bundle: ^3.0.2
• symfony/console: ~2.3|~3.0|~4.0|~5.0
• symfony/dependency-injection: ~2.3|~3.0|~4.0|~5.0
• symfony/framework-bundle: ~2.3|~3.0|~4.0|~5.0

Suggests

• friendsofsymfony/rest-bundle: FOSRestBundle provides several tools to assist in building REST applications
• lexik/jwt-authentication-bundle: Lexit JWTauthenticationBundle provides JWT authentication for your Symfony REST API

BSD-2-Clause

• Benjamin Touchard

• generator
• android
• REST API

README

This bundle provides a command to generate Android application and needed RESTApi based on your bundle definition.

Requirements

PHP7, Symfony 3.X, 4.X, 5.X

How it works

A generator prompt some information: AppName, package, destination folder, ... After generate Android application based on YourBundle in destination folder :

• Entity's and ContentProvider's based on YourBundle\Entity class.
• Account based on FOSUser (YourBundle\Entity\User).
• SyncService and SyncAdapter between Account and Provider's.

Base application generated contain some additional class:

• Api class for authentication and communication with Api.
• Authenticator system (include Account login activity and Account service).
• Helper's for Account, Database and Entity
• Various utilities class.
• And a Constant class (root package) that containing features like DB version, API url, ...

Installation

Android SDK must be installed !!

Add minimum-stability rule to your composer.json

...
"minimum-stability": "dev",
...

Next install AndroidGeneratorBundle using composer

$ composer require kolapsis/androidgenerator-bundle

I also advise you to install:

$ composer require friendsofsymfony/rest-bundle
$ composer require lexik/jwt-authentication-bundle

Usage

• Create your FOSUser class and configure FOSUser
• Create your's Entities in YourBundle\Entity with AndroidAnnotation
• Create your API and configure firewall (being built generator)
• Generate your Android Application with:

$ php bin/console android:create:app YourBundle

Or

$ php bin/console generate:android:app YourBundle -t 24 -m 21 -s /opt/android -g 2.2.0 -a MyApp -p ~/workspace/MyApp -d host.com -u http://api.host.com

Documentation

Read the documentation

License

This bundle is under the BSD 2-Clause license. See the complete license in the bundle:

Resources/meta/LICENSE