https://github.com/rommansabbir/vlogx
A visual logger for Android
https://github.com/rommansabbir/vlogx
android androidlibrary androidlogger androidlogginglib commander kotlin logger logging visuallog visuallogging
Last synced: about 2 months ago
JSON representation
A visual logger for Android
- Host: GitHub
- URL: https://github.com/rommansabbir/vlogx
- Owner: rommansabbir
- Created: 2023-06-16T07:39:06.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-07-07T09:28:51.000Z (almost 2 years ago)
- Last Synced: 2025-01-30T15:16:46.084Z (4 months ago)
- Topics: android, androidlibrary, androidlogger, androidlogginglib, commander, kotlin, logger, logging, visuallog, visuallogging
- Language: Kotlin
- Homepage:
- Size: 138 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](#getting-started-quick)
⚡ Latest Version: 1.0.0 🔰
- Send log to VLogX while the application is in **Debug Mode** only.
- Simple APIs to show and manage logs.
- Allows to clear existing logs before sending new a log.
- Auto close the log view by calling specific API or press the close button.
[](#getting-started-quick)
Installation
## ➤ Step 1:
Add the JitPack repository to your build file .
```gradle
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
```
## ➤ Step 2:
Add the dependency.
```gradle
dependencies {
implementation 'com.github.rommansabbir:vlogx:1.0.0'
}
```
## ➤ Step 3:
Initialize `VLogX` from your `Application.onCreate()`
```` kotlin
VLogXService.init(this)
````
## ➤ Step 4:
- Send a new log.
````kotlin
sendLog("This is our first log :D *-*")
````
- Clear existing logs.
````kotlin
clearLog()
````
- Clear existing and exit VLogX.
````kotlin
clearAndCloseLog()
````
[](#getting-started-quick)
Notes:
- **VLogX** is desgined to work only in **Debug Mode** to prevent showing senstive logs to the product users.
[](#getting-started-quick)
Contributors:
- Amanullah Sarker
- Romman Sabbir
[](#getting-started-quick)
### License
[Apache Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
````html
Copyright (C) 2023 VLogX
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.
````