Skip to content

Latest commit

 

History

History
148 lines (118 loc) · 6.24 KB

README.md

File metadata and controls

148 lines (118 loc) · 6.24 KB
Raw

Shiori

A Genshin Impact database kinda app

This app is not affiliated with or endorsed by miHoYo. Shiori is just a database app for the Genshin Impact game

Tests codecov

Features

  • Artifacts
  • Characters
  • Weapons
  • Materials
  • And many more to come

Discord

Contributing

Before contributing, please ask me if whatever you are planning to do / add / improve is valid for this project.

To run the server:

  • Install the .net 6 runtime HERE
  • Download and extract the server.zip
  • Open a terminal and run one of the following commands (depending on the OS / shell the command may vary)
    • dotnet ShioriAssets.dll
    • ./ShioriAssets
  • After running the command you should see an output like this:
info: Microsoft.Hosting.Lifetime[14]
Now listening on: http://localhost:5000
info: Microsoft.Hosting.Lifetime[14]
Now listening on: https://localhost:5001
info: Microsoft.Hosting.Lifetime[0]
Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
Hosting environment: Production
  • Take note of the url's port, since you will need it later
  • Copy the url and open it in your browser, you should see an It works! text

To run the app:

  • Clone this repository
  • Checkout the develop branch
  • Create a .env.common file with the following content, the values can be anything:
ANDROID_PURCHASES_KEY = yyyyy
IOS_PURCHASES_KEY = yyyyy
COMMON_HEADER_NAME = header
API_HEADER_NAME = key
PUBLIC_KEY = xxxzzzzz
PRIVATE_KEY = xxxxzzz
LETS_ENCRYPT_KEY = xxxzzzzxxx
  • Create a .env.dev and a copy named .env.prod with the following content (The url is the one used for the server, should work if you are using an android emulator)
API_BASE_URL = https://10.0.2.2:5001
ASSETS_BASE_URL = https://10.0.2.2:5001
API_HEADER_VALUE = value
  • Install the Flutter Intl extension (It is available in Vs Code and Android Studio)
  • Run the flutter intl initialize command from your IDE
  • Comment the lines 19 to 30 in the infrastructure/api_service.dart and add the following behind line 31 httpClient.badCertificateCallback = (X509Certificate cert, String host, int port) => true;
  • If you have fvm configured, run the script sh run_clean.sh, otherwise manually run each sentence without the fvm prefix
  • Follow the steps to setup firebase from here
  • Profit

Translations

If you want to help me with translations, I encourage you to check the following file:

  • The general one (where common strings are stored [not related specifically to the game]): General

To translate the general one is very simple, create a copy of the file, keeping the keys and translate the values: E.g (in spanish) : "dark" :"Oscuro"

Special Thanks

Translators

Translating the app to other languages won't have been possible without the following contributors

Chinese Russian Portuguese Italian Japanese Vietnamese Indonesian Ukrainian
2O48#9733 SipTik#8026 Brunoff#0261 Reniel [Skidex ツ]#7982 𝕽𝖚𝖗𝖎#3080 Ren Toky#5263 Arctara#7162 VALLER1Y#4726
KKTS#8567 DanPS#4336 F
pill#0039.
Avantel#8880
чебилин#5968
Anixty#3279