https://github.com/phpmyadmin/website

phpMyAdmin's website generator
https://github.com/phpmyadmin/website

django phpmyadmin python website

Last synced: 5 days ago
JSON representation

phpMyAdmin's website generator

• Host: GitHub
• URL: https://github.com/phpmyadmin/website
• Owner: phpmyadmin
• Created: 2012-02-05T09:46:30.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2024-10-26T19:12:58.000Z (19 days ago)
• Last Synced: 2024-10-26T21:24:35.636Z (19 days ago)
• Topics: django, phpmyadmin, python, website
• Language: Python
• Homepage: https://www.phpmyadmin.net/
• Size: 41.6 MB
• Stars: 46
• Watchers: 20
• Forks: 100
• Open Issues: 16
• Metadata Files:
  • Readme: README.rst
  • Changelog: news/__init__.py
  • Security: security/__init__.py

Awesome Lists containing this project

README

        
Website for phpMyAdmin

======================

Django code for phpMyAdmin's website.

.. image:: https://github.com/phpmyadmin/website/workflows/Run%20tests/badge.svg

    :target: https://github.com/phpmyadmin/website/actions

.. image:: https://codecov.io/github/phpmyadmin/website/coverage.svg?branch=master

    :target: https://codecov.io/github/phpmyadmin/website?branch=master

.. image:: https://app.codacy.com/project/badge/Grade/4cfc116f766947dcad6c006b295aafc2

    :target: https://www.codacy.com/app/phpMyAdmin/website

Requirements

------------

Website needs Python 3.7, additional dependencies are listed in `requirements.txt`.

Security announcements and news

-------------------------------

Edit announcements and news entries in the web UI.

Security issues are not publicly visible as long as they are marked as draft.

They are accessible through a separate URL (you can click `View on the site` link

while editing).

Page generating

---------------

Each page has its own template. For most things it means inclusion of

other templates to generate full page.

Menu

----

Menu is configured in data/menu.py, the first element always means page name

second menu item title.

Themes

------

Themes require additional metadata, which is stored in data/themes.py.

Awards

------

All awards are listed in data/awards.py.

Screenshots

-----------

All screenshots are listed in data/screenshots.py.

Development

-----------

For development, first install dependencies. The ones needed for running the

server are listed in ``requirements.txt``, for running testsuite in

``requirements-test.txt``. You can install them using your distribution (the

package names will usually add python- prefix) or using pip:

.. code-block:: sh

    pip install -r requirements-test.txt

You will need to apply migrations before loading test data:

.. code-block:: sh

    ./manage.py migrate

You might want to import some data to have at least some content on the website:

.. code-block:: sh

    ./manage.py loaddata pmaweb/fixtures/test_data.json

Once you have all dependencies, you can start development server:

.. code-block:: sh

    ./manage.py runserver

It will listed on port 8080 by default (you can change this by parameters).

To run test-suite execute:

.. code-block:: sh

    ./manage.py test

To add a new user (for `/admin/`):

.. code-block:: sh

    ./manage.py createsuperuser

Deployment

----------

Cron jobs:

.. code-block:: sh

    # Update translation stats

    ./manage.py fetch_translations

    # Update planet posts

    ./manage.py fetch_planet

File releases scan:

.. code-block:: sh

    # Import new releases from file storage

    ./manage.py import_files

    # Import new themes from file storage

    ./manage.py import_themes

License

-------

The website generator is licensed under GNU GPL version 2 or later.

Website itself uses some MIT licensed Javascript libraries:

* jQuery 

* Bootstrap 

* Colorbox 

The website content is licensed under Creative Commons

Attribution-Noncommercial-Share Alike 3.0 Unported License.