https://github.com/phpmyadmin/website
phpMyAdmin's website generator
https://github.com/phpmyadmin/website
django phpmyadmin python website
Last synced: about 1 month ago
JSON representation
phpMyAdmin's website generator
- Host: GitHub
- URL: https://github.com/phpmyadmin/website
- Owner: phpmyadmin
- Created: 2012-02-05T09:46:30.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2025-03-26T13:08:22.000Z (about 2 months ago)
- Last Synced: 2025-03-29T15:07:56.532Z (about 2 months ago)
- Topics: django, phpmyadmin, python, website
- Language: Python
- Homepage: https://www.phpmyadmin.net/
- Size: 41.5 MB
- Stars: 47
- Watchers: 19
- Forks: 101
- Open Issues: 15
-
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/actions/workflows/tests.yml/badge.svg?branch=master
:alt: Tests
:target: https://github.com/phpmyadmin/website/actions/workflows/tests.yml?query=branch%3Amaster
.. image:: https://codecov.io/github/phpmyadmin/website/coverage.svg?branch=master
:target: https://codecov.io/github/phpmyadmin/website?branch=master
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 the development server:
.. code-block:: sh
./manage.py runserver
It will listen on port 8000 by default (or use: `./manage.py runserver 127.0.0.1:8080` for a different port).
To run the 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.