generator-android-square-stack
v0.0.4
Published
Yeoman generator for Android+Square libs
Downloads
11
Maintainers
Readme
generator-android-square-stack
Yeoman generator
This generator will create a skeleton Android app built atop a collection of awesome Android libraries by Square using a single Activity/multiple view style.
Included libraries
- Dagger - dependency injection
- Mortar - composable, scoped modules
- Flow - sane navigation
- Retrofit - type-safe REST client
- Otto - event bus
- RXAndroid - reactive extensions for Android
The project also generates with a set of extremely useful test helper classes and static methods along with example tests showing how to use them.
Features
- Splash screen
- Production and test build flavors
- Environment selector menu
- Registration and Login screens (coming soon)
Getting Started
Install Yeoman
Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.
npm install -g yo
Install the Generator
Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.
To install generator-android-square-stack from npm, run:
npm install -g generator-android-square-stack
Finally, initiate the generator:
yo android-square-stack
This will create a fully functioning Android app skeleton.
Run it
Once you've generated the skeleton app simply import into Android Studio/IntelliJ (haven't tried with Eclipse & ADT sorry) as a Gradle project, perform a Gradle sync and then run!
License
MIT