{"id":13902546,"url":"https://github.com/thenishchalraj/Android-MVVM-Boilerplate-Creater","last_synced_at":"2025-07-18T00:31:33.166Z","repository":{"id":112548946,"uuid":"331008351","full_name":"thenishchalraj/Android-MVVM-Boilerplate-Creater","owner":"thenishchalraj","description":"A script that automates the tedious task of creating basic android files with the packages and imports for MVVM architecture.","archived":false,"fork":false,"pushed_at":"2021-02-02T06:06:59.000Z","size":225,"stargazers_count":71,"open_issues_count":0,"forks_count":12,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-11-23T23:32:45.307Z","etag":null,"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"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thenishchalraj.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-01-19T14:32:58.000Z","updated_at":"2024-01-04T16:54:04.000Z","dependencies_parsed_at":"2023-05-16T04:30:34.994Z","dependency_job_id":null,"html_url":"https://github.com/thenishchalraj/Android-MVVM-Boilerplate-Creater","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thenishchalraj%2FAndroid-MVVM-Boilerplate-Creater","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thenishchalraj%2FAndroid-MVVM-Boilerplate-Creater/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thenishchalraj%2FAndroid-MVVM-Boilerplate-Creater/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thenishchalraj%2FAndroid-MVVM-Boilerplate-Creater/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thenishchalraj","download_url":"https://codeload.github.com/thenishchalraj/Android-MVVM-Boilerplate-Creater/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226310619,"owners_count":17604615,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["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"],"created_at":"2024-08-06T22:01:12.161Z","updated_at":"2024-11-25T10:32:15.479Z","avatar_url":"https://github.com/thenishchalraj.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"#### Hey there!\n\n![Android MVVM Boilerplate Creater Logo](https://github.com/thenishchalraj/Android-MVVM-Boilerplate-Creater/blob/main/assets/logo_thumb.png)\n# Android MVVM Boilerplate Creater\nA script that creates the files and codes in them for android MVVM architecture in kotlin.\n\n\u003cimg src=\"https://img.shields.io/badge/Version-v1.3.1-green\" /\u003e \u003cimg src=\"https://img.shields.io/badge/License-MIT-blue\" /\u003e\n\n[Android-MVVM-Boilerplate-Creater - behind the scenes](https://proandroiddev.com/android-mvvm-boilerplate-creater-behind-the-scenes-1184e6d26fd3)\n\n### Features\n- [x] Type command \u003e Enter \u003e Done. (it's that fast)\n- [x] Each layer in different package.\n- [x] Generates basic utility package too.\n- [x] Packages with all the basic codes in Kotlin.\n- [x] Contains imports for all the files created.\n- [x] Uses Retrofit2, Dagger2 and Lifecycle.\n- [x] Dependencies and suggestions after boilerplate created.\n\n### Steps to run\n(tested on linux)\n\nMETHOD 1:\n* Go to the release space [here](https://github.com/thenishchalraj/Android-MVVM-Boilerplate-Creater/releases)\n* Download suitable Asset\n* Extract it\n* Move into the directory\n* Modify the file permission (if applicable)\n* Run according to the usage\n\nMETHOD 2:\n* `git clone https://github.com/thenishchalraj/Android-MVVM-Boilerplate-Creater.git`\n* `cd Android-MVVM-Boilerplate-Creater`\n* `chmod +x ./mvvm_creater.sh`\n* (for demo) `./mvvm_creater.sh ~/testing_dir Weather com.example.weatherapp`\n\nBoom! you're done.\n\n#### Packages and files that are created\n```\n.\n└── data/\n    ├── api/\n    │   ├── MainApi.kt\n    │   └── MainDataSource.kt\n    ├── model/\n    │   └── SomeModel.kt\n    ├── repository/\n    │   └── MainRepository.kt\n    ├── di/\n    │   ├── base/\n    │   │   ├── AppComponent.kt\n    │   │   ├── AppModule.kt\n    │   │   ├── ViewModelFactoryModule.kt\n    │   │   ├── ViewModelKey.kt\n    │   │   └── ViewModelModule.kt\n    │   ├── ActivityBuildersModule.kt\n    │   └── MainModule.kt\n    ├── ui/\n    │   ├── base/\n    │   │   └── ViewModelFactory.kt\n    │   └── main/\n    │       ├── view\n    │       └── viewmodel/\n    │           └── MainViewModel.kt\n    ├── utils/\n    │   ├── Endpoints.kt\n    │   ├── ISTDateDeserializer.kt\n    │   ├── Resource.kt\n    │   └── Status.kt\n    └── WeatherApplication.kt\n```\n\n### Usage\n* -h (shows help)\n* -s (shows suggestions)\n* -d (shows used dependencies)\n* arguments 1, 2, 3 (path-to-directory, base application name, application package name)\n\n### ToDos\n- [ ] Make the script compact/optimized\n- [ ] Different scripts for different architecture (MVP, MVC, Full-Modular or some best techniques)\n- [ ] Make and test its working on windows \u0026 mac\n\n### References\n* [Bash Cheatsheet](https://devhints.io/bash)\n* [Shell Scripting](https://tecadmin.net/tutorial/bash-scripting/)\n* [Functions in Bash](https://linuxize.com/post/bash-functions/)\n* [Exit in Bash](https://askubuntu.com/questions/892604/what-is-the-meaning-of-exit-0-exit-1-and-exit-2-in-a-bash-script)\n\n### Contribution\nFork 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.\n\n### License\nRead the license [here](https://github.com/thenishchalraj/Android-MVVM-Boilerplate-Creater/blob/main/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthenishchalraj%2FAndroid-MVVM-Boilerplate-Creater","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthenishchalraj%2FAndroid-MVVM-Boilerplate-Creater","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthenishchalraj%2FAndroid-MVVM-Boilerplate-Creater/lists"}