Skip to content

Unofficial multiplatform client for shikimori, written on Jetbrains compose

Notifications You must be signed in to change notification settings

RecodeLiner/Nextshiki-CM

Repository files navigation

Nextshiki

Nextshiki - unofficial MD3 client for Shikimori, written on Kotlin, Jetbrains Compose, Ktor and more. Client based on official API Shikimori.

Static Badge Github top language

Before running!

  • check your system with KDoctor
  • install JDK 8 on your machine
  • add local.properties file to the project root and set a path to Android SDK there
  • run ./gradlew podInstall in the project root

Setup authorization

To build application, you need to put in your nextshikiAuth.properties file auth data.
Get auth data you can from official site.
After this, you can set up your file like this:

appName=Nextshiki
# for mobile app:
clientId=
clientSecret=
domain=https://shikimori.one
redirectURI=
userAgent=Nextshiki
scope=
# for desktop app:
userAgentDesk=Nextshiki-desk
clientIDDesk=
clientSecretDesk=
redirectURIDesk=urn:ietf:wg:oauth:2.0:oob
scopeDesk=

If you want to set up only mobile or only desktop-app-set fields empty.

Android

To run the application on android device/emulator:

  • open project in Android Studio and run imported android run configuration

To build the application bundle:

  • run ./gradlew :sharedApp:assembleDebug
  • find .apk file in sharedApp/build/outputs/apk/debug/composeApp-debug.apk

Desktop

Run the desktop application: ./gradlew :sharedApp:run

For build release for your current OS run: ./gradlew packageReleaseDistributionForCurrentOS or for build a jar you can run: ./gradlew packageReleaseUberJarForCurrentOS
Then just find it in sharedApp\build\libs

iOS

To run the application on iPhone device/simulator:

For auto build using GitHub actions:

To auto build your application using GitHub actions, you need to put these secrets:

# For mobile:
CLIENT_ID
REDIRECT_URI
CLIENT_SECRET
CLIENT_DOMAIN
USER_AGENT
SCOPE
# For desktop:
CLIENT_ID_DESK
CLIENT_SECRET_DESK
REDIRECT_URI_DESK
SCOPE_DESK
USER_AGENT_DESK

About

Unofficial multiplatform client for shikimori, written on Jetbrains compose

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages