cyclone

Write JVM apps Android way

🛠 Installation

implementation 'com.theapache64:cyclone:1.0.0-beta01'

Story 🌲

I was just wondering would it be possible to write CLI apps like we write Android apps. By using the same structure, tools, and the APIs.

I started the project by cloning LiveData API structure. I made sure that it works as expected. After that I cloned API structures of ViewModel, Activity, Application, Context and Intent. (I didn't fully clone the component, but the minimum version to write a simple CLI app)

(By this time, you might have got why I named the project cyclone 😋)

Example 🔬

How to run the example ?

Run the main method
Give any username and password (length should be > 0)

Structure 📂

The example project contains 2 modules, Core and Example. Core module contains the cloned classes (library), and the Example module contains an example using the cloned classes.

The Example is a TODO app. It has below given features.

Log In
Todo Listing

Built With 🛠️

Coroutines 🔃
Dagger2 🗡️
Moshi 🔳
Retrofit 🌐

Directory Structure 📁

Library

.
└── core
    ├── Activity.kt
    ├── Application.kt
    ├── Context.kt
    ├── extensions
    │   └── FlowExtensions.kt
    ├── InputUtils.kt
    ├── Intent.kt
    ├── livedata
    │   ├── LiveData.kt
    │   └── MutableLiveData.kt
    └── network
        ├── BaseApiResponse.kt
        ├── flow
        │   ├── FlowResourceCallAdapterFactory.kt
        │   └── FlowResourceCallAdapter.kt
        └── Resource.kt

5 directories, 12 files

Example

.
└── example
    ├── App.kt
    ├── data
    │   ├── local
    │   ├── remote
    │   │   ├── ApiInterface.kt
    │   │   ├── login
    │   │   │   ├── LogInRequest.kt
    │   │   │   └── LogInResponse.kt
    │   │   └── todolist
    │   │       ├── TodoListRequest.kt
    │   │       └── TodoListResponse.kt
    │   └── repositories
    │       ├── TodoRepo.kt
    │       └── UserRepo.kt
    ├── di
    │   ├── components
    │   │   ├── LogInComponent.kt
    │   │   └── TodoListComponent.kt
    │   └── modules
    │       └── NetworkModule.kt
    ├── models
    ├── ui
    │   ├── login
    │   │   ├── LogInActivity.kt
    │   │   └── LogInViewModel.kt
    │   └── todolist
    │       ├── TodoListActivity.kt
    │       └── TodoListViewModel.kt
    └── utils

15 directories, 15 files

☑️ TODO

🥼 Run tests

./gradlew test

✍️ Author

👤 theapache64

Twitter: @theapache64
Email: theapache64@gmail.com

Feel free to ping me 😉

🤝 Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Open an issue first to discuss what you would like to change.
Fork the Project
Create your feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add some amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a pull request

Please make sure to update tests as appropriate.

❤ Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2021 - theapache64

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

This README was generated by readgen ❤

theapache64 / cyclone