Skip to content

Commit

Permalink
Merge pull request #4 from Yazan98/rename
Browse files Browse the repository at this point in the history
Rename Library Components
  • Loading branch information
Yazan98 authored Mar 11, 2022
2 parents fe303be + fd0aafd commit bd7552b
Show file tree
Hide file tree
Showing 559 changed files with 1,366 additions and 15,145 deletions.
17 changes: 8 additions & 9 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,11 @@
.externalNativeBuild
.cxx

/vortex-data/build
/vortex/build
/vortex-firebase/build
/vortex-prefs/build
/vortex-permissions/build
/vortex-ui/build
/vortex-utils/build
/vortex-logic/build
/vortex-data/build
/vanite-data/build
/vanite/build
/vanite-firebase/build
/vanite-prefs/build
/vanite-permissions/build
/vanite-ui/build
/vanite-utils/build
/vanite-logic/build
1 change: 1 addition & 0 deletions .idea/.name

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions .idea/dictionaries/yazan.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 9 additions & 9 deletions .idea/gradle.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

73 changes: 26 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
# Vortex
# Vanite

Android Infrastructure

![](https://img.shields.io/badge/Project%20Status-Under%20Development-blue)
[![Maven Central](https://img.shields.io/maven-central/v/com.yazantarifi/vortex.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.yazantarifi%22%20AND%20a:%22vortex%22)
[![Maven Central](https://img.shields.io/maven-central/v/com.yazantarifi/Vanite.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.yazantarifi%22%20AND%20a:%22Vanite%22)
![](https://img.shields.io/badge/License-Apache%202.0-yellow)
![](https://img.shields.io/badge/Language-Kotlin-orange)
![](https://img.shields.io/badge/Android%20Status-AndroidX-green)

# What is Vortex
# What is Vanite

Vortex is an Android Infrastructure To Build Android Applications With Latest Technologies and Ready State Handling with User Interface Implementation For The Android Common Cases
Vanite is an Android Infrastructure To Build Android Applications With Latest Technologies and Ready State Handling with User Interface Implementation For The Android Common Cases
This Library is Not Just Base Code it's also help you to get the target as soon as possible with ready techniques, base code for everything and this library built on modularity architecture
actually you can depends on Vortex To Build Any Kind Of Android Apps , but the problem here this library depends on other android apis to implement some operations
like google maps and 3th libraries to make sure your application has the right dependencies to start using Vortex Library you should apply 2 Gradle Plugins
The First One For Vortex Dependcies With Multi Modular Application To Apply The Right Dependency to Right Module, the Second one should provide the application the right dependencies to each module
actually you can depends on Vanite To Build Any Kind Of Android Apps , but the problem here this library depends on other android apis to implement some operations
like google maps and 3th libraries to make sure your application has the right dependencies to start using Vanite Library you should apply 2 Gradle Plugins
The First One For Vanite Dependcies With Multi Modular Application To Apply The Right Dependency to Right Module, the Second one should provide the application the right dependencies to each module

# Multi Modular Application
Vortex has Main 3 Modules you should include in your app to install Vortex
Vanite has Main 3 Modules you should include in your app to install Vanite

> Note: Vortex Don't Support Single Module Application Gradle Plugins Don't Working With Single Module
> Note: Vanite Don't Support Single Module Application Gradle Plugins Don't Working With Single Module
Each Application Should Implemented With 3 Layers (ui, data, domain)
1. UI -> User Interface it includes (Activities, Fragments, Notifications, Dialogs, Application Configuration) -- Optional Dagger Application Scope
Expand All @@ -28,11 +28,11 @@ Each Application Should Implemented With 3 Layers (ui, data, domain)

3. DOMAIN -> This Layer Should include The ViewModels With Application Business Logic Because Each ViewModel has The Hole Logic For Each Section and this is the important part in the application for this all ViewModels in the Same Layer

# Vortex Logic Handling
1. State : Vortex is Working Depends on Android Architecture Component it means The Base Layer in Vortex is ViewModel and The Application State Management Depends On LiveData Handling
# Vanite Logic Handling
1. State : Vanite is Working Depends on Android Architecture Component it means The Base Layer in Vanite is ViewModel and The Application State Management Depends On LiveData Handling
There are a lot of ways you can deliver the Direct State to View With Ready State or Custom State

#### Vortex State Types
#### Vanite State Types
1.1 : State, Action Handling : This Way Requires Two Parameters The First One is Action and The Second One The Base State For This ViewModel
You can Use This Way To Create ViewModel That Can Handle The SuccessState, ErrorState, LoadingState, EmptyState and This Way Inspired From Redux State Handling
And The Action Will explain later
Expand All @@ -45,9 +45,9 @@ And The Action Will explain later

1.5 : IndirectViewModel : This ViewModel like SingleStateViewModel but it just handle The State Without Loading Handling

#### Vortex Actions
#### Vanite Actions

Vortex ViewModels and Views Requires The Actions Because any View Can Just send Actions To Any Type of ViewModel using execute Method
Vanite ViewModels and Views Requires The Actions Because any View Can Just send Actions To Any Type of ViewModel using execute Method
in this case You can Declare The Base Action And Handle The Childes

Here You Can Tell The ViewModel You Should Handle The Auth Actions And The Childes Of This Action is Login, Register Actions Just and Don't Handle Anything Else
Expand All @@ -68,43 +68,22 @@ allprojects {

```
dependencies {
implementation 'com.yazantarifi:vortex:2.3.1'
implementation 'com.yazantarifi:vortex-data:2.3.1'
implementation 'com.yazantarifi:vortex-utils:2.3.1'
implementation 'com.yazantarifi:vortex-ui-binding:2.3.1'
implementation 'com.yazantarifi:vortex-ui:2.3.1'
implementation 'com.yazantarifi:vortex-prefs:2.3.1'
implementation 'com.yazantarifi:vortex-permissions:2.3.1'
implementation 'com.yazantarifi:vortex-log:2.3.1'
implementation 'com.yazantarifi:vortex-firebase:2.3.1'
implementation 'com.yazantarifi:Vanite:1.0.0'
implementation 'com.yazantarifi:Vanite-data:1.0.0'
implementation 'com.yazantarifi:Vanite-utils:1.0.0'
implementation 'com.yazantarifi:Vanite-ui-binding:1.0.0'
implementation 'com.yazantarifi:Vanite-ui:1.0.0'
implementation 'com.yazantarifi:Vanite-prefs:1.0.0'
implementation 'com.yazantarifi:Vanite-permissions:1.0.0'
implementation 'com.yazantarifi:Vanite-log:1.0.0'
implementation 'com.yazantarifi:Vanite-firebase:1.0.0'
}
```
# Vortex Gradle Plugin

```
buildscript {
repositories {
maven {
url "https://plugins.gradle.org/m2/"
}
}
dependencies {
classpath "gradle.plugin.io.vortex.gradle.plugin.dependencies:vortex-dependencies-plugin:2.3.1"
}
}
```

3. Each Module Should Implement The Plugin

```
apply plugin: "io.vortex.gradle.plugin.dependencies"
```


# Vortex Documentation
Coming Soon Vortex still Under Development
# Vanite Documentation
Coming Soon Vanite still Under Development

# License

Copyright (C) 2019 Vortex is An Open Source Library (Licensed under the Apache License, Version 2.0)
Copyright (C) 2019 Vanite is An Open Source Library (Licensed under the Apache License, Version 2.0)

20 changes: 0 additions & 20 deletions application-flow/android-flow.md

This file was deleted.

2 changes: 0 additions & 2 deletions application-flow/spring-boot-flow.md

This file was deleted.

16 changes: 8 additions & 8 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ buildscript {
"EasyLauncherPluginV": "1.3.1",
"FirebasePluginV" : "4.3.1",
"NavigationPluginV" : "2.2.0-rc04",
"VortexPluginV" : "1.0.0",
"VanitePluginV" : "1.0.0",
"HiltPluginVersion" : "2.28-alpha",
"NexusPublishPluginVersoin": "1.1.0"
]
Expand Down Expand Up @@ -52,17 +52,17 @@ apply from: "${rootDir}/scripts/publish-root.gradle"

ext {
PUBLISH_GROUP_ID = 'com.yazantarifi'
PUBLISH_VERSION = '2.3.1'
PUBLISH_DESCRIPTION = 'Shake Reporting To Report Android Crashes, Application Requests'
PUBLISH_URL = 'https://github.com/Yazan98/Vortex'
PUBLISH_VERSION = '1.0.0'
PUBLISH_DESCRIPTION = 'Application Structure, Base Code, Configuration, Utility Classes to Build Android Applications'
PUBLISH_URL = 'https://github.com/Yazan98/Vanite'
PUBLISH_LICENSE_NAME = 'MIT'
PUBLISH_LICENSE_URL = 'https://github.com/Yazan98/Vortex/blob/main/LICENSE'
PUBLISH_LICENSE_URL = 'https://github.com/Yazan98/Vanite/blob/main/LICENSE'
PUBLISH_DEVELOPER_ID = 'yt98'
PUBLISH_DEVELOPER_NAME = 'Yazan Tarifi'
PUBLISH_DEVELOPER_EMAIL = '[email protected]'
PUBLISH_SCM_CONNECTION = 'scm:git:github.com/Yazan98/Vortex.git'
PUBLISH_SCM_DEVELOPER_CONNECTION = 'scm:git:ssh://github.com/Yazan98/Vortex.git'
PUBLISH_SCM_URL = 'https://github.com/Yazan98/Vortex/tree/master'
PUBLISH_SCM_CONNECTION = 'scm:git:github.com/Yazan98/Vanite.git'
PUBLISH_SCM_DEVELOPER_CONNECTION = 'scm:git:ssh://github.com/Yazan98/Vanite.git'
PUBLISH_SCM_URL = 'https://github.com/Yazan98/Vanite/tree/master'
}

subprojects {
Expand Down
2 changes: 0 additions & 2 deletions intellij-plugin/.idea/.gitignore

This file was deleted.

1 change: 0 additions & 1 deletion intellij-plugin/.idea/.name

This file was deleted.

10 changes: 0 additions & 10 deletions intellij-plugin/.idea/codeStyles/Project.xml

This file was deleted.

5 changes: 0 additions & 5 deletions intellij-plugin/.idea/codeStyles/codeStyleConfig.xml

This file was deleted.

20 changes: 0 additions & 20 deletions intellij-plugin/.idea/gradle.xml

This file was deleted.

25 changes: 0 additions & 25 deletions intellij-plugin/.idea/jarRepositories.xml

This file was deleted.

7 changes: 0 additions & 7 deletions intellij-plugin/.idea/misc.xml

This file was deleted.

Loading

0 comments on commit bd7552b

Please sign in to comment.