https://github.com/openzim/zimit-frontend

Zimit Public Web UI
https://github.com/openzim/zimit-frontend

spider warc zim

Last synced: 11 months ago
JSON representation

Zimit Public Web UI

• Host: GitHub
• URL: https://github.com/openzim/zimit-frontend
• Owner: openzim
• License: gpl-3.0
• Created: 2020-11-18T09:14:20.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2025-07-17T16:17:34.000Z (11 months ago)
• Last Synced: 2025-07-17T19:03:57.482Z (11 months ago)
• Topics: spider, warc, zim
• Language: Python
• Homepage: https://zimit.kiwix.org
• Size: 604 KB
• Stars: 20
• Watchers: 4
• Forks: 14
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# zimit-frontend

[![CodeFactor](https://www.codefactor.io/repository/github/openzim/zimit-frontend/badge)](https://www.codefactor.io/repository/github/openzim/zimit-frontend)

[![Docker](https://ghcr-badge.egpl.dev/openzim/zimit-ui/latest_tag?label=docker)](https://ghcr.io/openzim/zimit-ui)

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

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](https://github.com/openzim/overview/wiki/Contributing).

`zimit-frontend` has implemented openZIM's [Python bootstrap, conventions and policies](https://github.com/openzim/_python-bootstrap/blob/main/docs/Policy.md) **v1.0.3**.

## How-to

### Run the project

This project is better deployed with its [Docker image](https://ghcr.io/openzim/zimit-ui) 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](./dev/README.md) 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