Files
jam.py-v7_documentation_rework/source/index.rst
T
2026-05-21 18:39:29 +02:00

151 lines
4.9 KiB
ReStructuredText

.. Comments section.
Please, add custom directive or links, pictures, text replacement at the end of this document
=======================
Jam.py V7 documentation
=======================
Introduction
==============
Welcome to Jam.py! If you are new to Jam.py or no-code, low-code or more-code Web application development, this is the place to find documentation about the Jam.py V7.
The biggest difference to Jam.py V5 is :
- :doc:`routing </admin/routing>` support
- Bootstrap 5
- modern support for mobile devices (see :doc:`version 7 </releases/version_7/index>`).
In addition, the complete interface for |desktop_ico| :doc:`Desktop </admin/items/view_form_dialog>` or |mobile_phone_ico| :doc:`Mobile </admin/items/edit_form_dialog>` devices is driven by a no-code approach.
Just select what is needed for any device and off you go.
|objectives_ico| **Objectives**
Installing Python [1]_ and Jam.py, choosing the database and the Web server and making Application Design decisions.
|audience_ico| **Audience**
Web development enthusiasts or developers, with a limited or no experience with the Web development, or deployment.
|prerequisites_ico| **Prerequisites**
The general knowledge about the Command Line prompt, and typing the commands is required and for advanced usages some Python and JavaScript knowledge is recommended.
Feed the LLM
==============
The LLMS-full.txt is released:
- https://jampy-docs-v7.readthedocs.io/en/latest/llms-full.txt
- https://jampy-docs-v7.readthedocs.io/en/latest/llms.txt
The Github Jam.py repository: https://github.com/jam-py-v5/jam-py-v7
Documentation Layout Overview
==================================
Here is an overview of the documentation layout, to
help you find out where to look for specific details:
:doc:`Getting started <intro/index>` topics describe how to install the framework, create
a new project, develop a web application step-by-step, and deploy it.
:doc:`Programming guides<programming/index>`
discuss key topics and concepts at a fairly high level and provide useful
background information and explanation.
:doc:`Business application builder <admin/index>` is a detailed description of
the Application Builder used for application development and database
administration.
:doc:`Class reference guides <refs/index>` contain technical reference for
Jam.py classes APIs.
:doc:`FAQ <faq/index>` topics covers most frequently asked questions.
:doc:`How to <how_to/index>` contains code examples that can be useful to quickly
accomplish common tasks.
Please visit the
:doc:`table of contents <contents>` or even
`Jam.py Application Design Tips`_, for detailed steps how to build the applications or migrate from MS Access.
.. _`Jam.py Application Design Tips`: https://jampy-application-design-tips.readthedocs.io/
Documentation Download
======================
To download this document as a single PDF, please visit https://jampy-docs-v7.readthedocs.io/_/downloads/en/latest/pdf/
Documentation Translations
===========================
|china_flag_ico| Simplified Chinese translation started at https://jampy-docs.readthedocs.io/projects/V7/zh-cn/latest
Video Tutorials
===============
| If you are new to Jam.py, we highly recommend that you watch these video tutorials.
| The videos are referring to Jam.py V5. There are minimal changes to the User interface compared to V7.
It is recommended to watch these videos with a resolution of 1080p.
- Tutorial 1 - `Working with files and images <https://youtu.be/9rFXPyfN0Hg>`__
- Tutorial 2 - `Working with details <https://youtu.be/sbvxE-vEfsM>`__
- Tutorial 3 - `Users, roles, audit trail/change history <https://youtu.be/60LiWZa0CpY>`__
- Tutorial 4 - `Task tree <https://youtu.be/hsSKqEh6vL4>`__
- Tutorial 5 - `Forms <https://youtu.be/3sh-TSt52P0>`__
- Tutorial 6 - `Form events <https://youtu.be/DY463lcv0R4>`__
- Tutorial 7 - `Data aware controls <https://youtu.be/fMTq8P4XdGw>`__
- Tutorial 8 - `Datasets <https://youtu.be/gHTYj7h9ljI>`__
- Tutorial 9 - `Datasets Part 2 <https://youtu.be/1bUGmgBfrNw>`__
- Tutorial 10 - `Fields and filters <https://youtu.be/ahXqlZrA0fQ>`__
- Tutorial 11 - `Client-server interactions <https://youtu.be/nLOhdA2FX0I>`__
- Tutorial 12 - `Working with data on the server <https://youtu.be/dDK78lIjHHY>`__
.. [1] Only if you have no Python installer or unsupported Python version.
.. |audience_ico| image:: ./_images/audience.png
:height: 4ex
:class: no-scaled-link
.. |objectives_ico| image:: ./_images/objectives.png
:height: 4ex
:class: no-scaled-link
.. |prerequisites_ico| image:: ./_images/prerequisites.png
:height: 4ex
:class: no-scaled-link
.. |desktop_ico| image:: ./_images/desktop.png
:height: 2ex
:class: no-scaled-link
.. |mobile_phone_ico| image:: ./_images/iphonex.png
:height: 2ex
:class: no-scaled-link
.. |china_flag_ico| image:: ./_images/china_flag.png
:height: 3ex
:class: no-scaled-link