Skip to content

Latest commit

 

History

History
38 lines (23 loc) · 1.86 KB

README.md

File metadata and controls

38 lines (23 loc) · 1.86 KB
Raw

zimit-frontend

CodeFactor Docker License: GPL v3

This project is a UI (and its API / backend-for-frontend) allowing any user to submit Zimit requests to a Zimfarm instance. It is NOT a standalone tool allowing to run zimit scraper. A Zimfarm instance and associated worker(s) is required for the system to be functional.

You can see it live at https://zimit.kiwix.org.

zimit-frontend adheres to openZIM's Contribution Guidelines.

zimit-frontend has implemented openZIM's Python bootstrap, conventions and policies v1.0.3.

How-to

Run the project

This project is better deployed with its Docker image which is ready to use (you still need to deploy Zimfarm separately).

Contribute

You can start a development stack with most required components in the dev folder. See README there.

Internationalization (i18n)

This project supports internationalization, including RTL languages.

Strings to translate are hosted in the locales folder, but it is better to direct to TranslateWiki to translate this project.

Should you want to add a new language, the new code must be declared at following locations:

  • supportedLanguages constant in ui/src/i18n.ts to declare the code, associated label in the UI and LTR/RTL direction
  • rtl_language_codes constant in api/src/zimitfrontend/constants.py to declare the LTR/RTL direction