https://github.com/thenishchalraj/Android-MVVM-Boilerplate-Creater

A script that automates the tedious task of creating basic android files with the packages and imports for MVVM architecture.
https://github.com/thenishchalraj/Android-MVVM-Boilerplate-Creater

android android-architecture android-development android-studio bash-script dagger2-android kotlin kotlin-android mvvm mvvm-android mvvm-architecture mvvm-pattern retrofit2 retrofit2-kotlin script shell-script

Last synced: about 2 months ago
JSON representation

A script that automates the tedious task of creating basic android files with the packages and imports for MVVM architecture.

• Host: GitHub
• URL: https://github.com/thenishchalraj/Android-MVVM-Boilerplate-Creater
• Owner: thenishchalraj
• License: mit
• Created: 2021-01-19T14:32:58.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-02-02T06:06:59.000Z (over 3 years ago)
• Last Synced: 2024-07-27T10:32:14.734Z (2 months ago)
• Topics: android, android-architecture, android-development, android-studio, bash-script, dagger2-android, kotlin, kotlin-android, mvvm, mvvm-android, mvvm-architecture, mvvm-pattern, retrofit2, retrofit2-kotlin, script, shell-script
• Language: Shell
• Homepage:
• Size: 220 KB
• Stars: 71
• Watchers: 3
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - thenishchalraj/Android-MVVM-Boilerplate-Creater - A script that automates the tedious task of creating basic android files with the packages and imports for MVVM architecture. (Shell)

README

        
#### Hey there!

![Android MVVM Boilerplate Creater Logo](https://github.com/thenishchalraj/Android-MVVM-Boilerplate-Creater/blob/main/assets/logo_thumb.png)

# Android MVVM Boilerplate Creater

A script that creates the files and codes in them for android MVVM architecture in kotlin.

 

[Android-MVVM-Boilerplate-Creater - behind the scenes](https://proandroiddev.com/android-mvvm-boilerplate-creater-behind-the-scenes-1184e6d26fd3)

### Features

- [x] Type command > Enter > Done. (it's that fast)

- [x] Each layer in different package.

- [x] Generates basic utility package too.

- [x] Packages with all the basic codes in Kotlin.

- [x] Contains imports for all the files created.

- [x] Uses Retrofit2, Dagger2 and Lifecycle.

- [x] Dependencies and suggestions after boilerplate created.

### Steps to run

(tested on linux)

METHOD 1:

* Go to the release space [here](https://github.com/thenishchalraj/Android-MVVM-Boilerplate-Creater/releases)

* Download suitable Asset

* Extract it

* Move into the directory

* Modify the file permission (if applicable)

* Run according to the usage

METHOD 2:

* `git clone https://github.com/thenishchalraj/Android-MVVM-Boilerplate-Creater.git`

* `cd Android-MVVM-Boilerplate-Creater`

* `chmod +x ./mvvm_creater.sh`

* (for demo) `./mvvm_creater.sh ~/testing_dir Weather com.example.weatherapp`

Boom! you're done.

#### Packages and files that are created

```

.

└── data/

    ├── api/

    │   ├── MainApi.kt

    │   └── MainDataSource.kt

    ├── model/

    │   └── SomeModel.kt

    ├── repository/

    │   └── MainRepository.kt

    ├── di/

    │   ├── base/

    │   │   ├── AppComponent.kt

    │   │   ├── AppModule.kt

    │   │   ├── ViewModelFactoryModule.kt

    │   │   ├── ViewModelKey.kt

    │   │   └── ViewModelModule.kt

    │   ├── ActivityBuildersModule.kt

    │   └── MainModule.kt

    ├── ui/

    │   ├── base/

    │   │   └── ViewModelFactory.kt

    │   └── main/

    │       ├── view

    │       └── viewmodel/

    │           └── MainViewModel.kt

    ├── utils/

    │   ├── Endpoints.kt

    │   ├── ISTDateDeserializer.kt

    │   ├── Resource.kt

    │   └── Status.kt

    └── WeatherApplication.kt

```

### Usage

* -h (shows help)

* -s (shows suggestions)

* -d (shows used dependencies)

* arguments 1, 2, 3 (path-to-directory, base application name, application package name)

### ToDos

- [ ] Make the script compact/optimized

- [ ] Different scripts for different architecture (MVP, MVC, Full-Modular or some best techniques)

- [ ] Make and test its working on windows & mac

### References

* [Bash Cheatsheet](https://devhints.io/bash)

* [Shell Scripting](https://tecadmin.net/tutorial/bash-scripting/)

* [Functions in Bash](https://linuxize.com/post/bash-functions/)

* [Exit in Bash](https://askubuntu.com/questions/892604/what-is-the-meaning-of-exit-0-exit-1-and-exit-2-in-a-bash-script)

### Contribution

Fork the repository, either do your own improvements or pick something from the ToDos or Issues and start a PR to the `dev` branch after successful testing.

### License

Read the license [here](https://github.com/thenishchalraj/Android-MVVM-Boilerplate-Creater/blob/main/LICENSE)