## 1. Project Overview & Quickstart (WeblateOrg/weblate)

## File: README.rst

.. image:: https://s.weblate.org/cdn/Logo-Darktext-borders.png
   :alt: Weblate
   :target: https://weblate.org/
   :height: 80px

**Weblate is libre software web-based continuous localization system,
used by over 2500 libre projects and companies in more than 165 countries.**

Install it, or use the Hosted Weblate service at `weblate.org`_.

.. image:: https://img.shields.io/badge/website-weblate.org-blue.svg
    :alt: Website
    :target: https://weblate.org/

.. image:: https://hosted.weblate.org/widget/weblate/svg-badge.svg
    :alt: Translation status
    :target: https://hosted.weblate.org/engage/weblate/

.. image:: https://www.bestpractices.dev/projects/552/badge
    :alt: CII Best Practices
    :target: https://www.bestpractices.dev/en/projects/552

.. image:: https://api.reuse.software/badge/github.com/WeblateOrg/weblate
    :alt: REUSE status
    :target: https://api.reuse.software/info/github.com/WeblateOrg/weblate

.. image:: https://img.shields.io/pypi/v/weblate.svg
    :target: https://pypi.org/project/Weblate/

.. image:: https://readthedocs.org/projects/weblate/badge/
    :target: https://docs.weblate.org/

.. image:: https://img.shields.io/github/license/WeblateOrg/weblate.svg
    :alt: License
    :target: https://github.com/WeblateOrg/weblate/blob/main/LICENSE

.. image:: https://argos-ci.com/badge.svg
    :alt: Covered by Argos Visual Testing
    :target: https://app.argos-ci.com/weblate/weblate/reference?utm_source=weblate&utm_campaign=oss

Support
-------

Weblate is libre software with optional professional support and cloud
hosting offerings. Check out https://weblate.org/hosting/ for more information.

Documentation
-------------

To be found in the ``docs`` directory of the source code, or
viewed online on https://docs.weblate.org/

Installation
------------

Setup instructions:

https://docs.weblate.org/en/latest/admin/install.html

Bugs
----

Please report feature requests and problems to:

https://github.com/WeblateOrg/weblate/issues

Accessibility
-------------

Please report accessibility problems using the accessibility issue template.
See ``ACCESSIBILITY.md`` for Weblate's accessibility target and reporting
guidance.

Stats
-----

.. image:: https://repobeats.axiom.co/api/embed/e0cfcc1b19f13f78669d3a93ca26b59974faaa22.svg
   :alt: Repobeats analytics image

License
-------

Copyright © Michal Čihař michal@weblate.org

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the `GNU General Public License
<https://www.gnu.org/licenses/gpl-3.0.html>`_ for more details.

.. _weblate.org: https://weblate.org/

## 2. Official Technical Reference & Guides (WeblateOrg/website)

## File: README.rst

.. image:: https://s.weblate.org/cdn/Logo-Darktext-borders.png
   :alt: Weblate
   :target: https://weblate.org/
   :height: 80px

**Weblate is libre software web-based continuous localization system,
used by over 2500 libre projects and companies in more than 165 countries.**


Django based website for Weblate, running at <https://weblate.org/>.

.. image:: https://img.shields.io/badge/website-weblate.org-blue.svg
    :alt: Website
    :target: https://weblate.org/

.. image:: https://codecov.io/github/WeblateOrg/website/coverage.svg?branch=main
    :alt: Coverage Status
    :target: https://codecov.io/github/WeblateOrg/website?branch=main

.. image:: https://hosted.weblate.org/widget/weblate/website/status-badge.png
    :alt: Translation status
    :target: https://hosted.weblate.org/engage/weblate/

.. image:: https://img.shields.io/github/license/WeblateOrg/website.svg
    :alt: License
    :target: https://github.com/WeblateOrg/website/blob/main/LICENSE

.. image:: https://argos-ci.com/badge.svg
    :alt: Covered by Argos Visual Testing
    :target: https://app.argos-ci.com/weblate/website/reference?utm_source=weblate&utm_campaign=oss

Weblate
-------

Find Weblate at https://github.com/WeblateOrg/weblate.

Running locally
---------------

Create virtual env and install dependencies:

.. code-block:: sh

   uv sync --dev
   source .venv/bin/activate

Create ``weblate_web/settings_local.py`` which adjust your settings:

.. code-block:: py

   # Disable SAML login, use local
   LOGIN_URL = "/admin/login/"

   # You can also configure API keys and other things, see weblate_web/settings.py

   # Do not send real e-mails, log them to the console
   EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"

Create admin:

.. code-block:: sh

   ./manage.py createsuperuser --username admin --email noreply@weblate.org

Migrate the database:

.. code-block:: sh

   ./manage.py migrate

Import subscription packages to the database:

.. code-block:: sh

   ./manage.py sync_packages

Compile MO files so that translations can be used:

.. code-block:: sh

   ./manage.py compilemessages

Run the development server:

.. code-block:: sh

   ./manage.py runserver