phpgt / phpgt/WebEngine

Docs: missing pieces

Open
#672 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PHP
Stars
26
Forks
6
PR merge metrics
No merged PRs in 30d

Description

Overview:

Explain the following:

  • the difference between Page View, Page Logic, API View/Logic, components, partials.
  • HTML is concatenated/assembled before DOM processing.
  • How the DOM document is manipulated with data-bind.
  • PHP is optional and added only when needed by the developer.
  • Dynamic route filenames can be used with @.
  • Magic files like _header, _footer, and _common, and when not to use with partials.
  • Logic methods go, do_* with links to read more about advanced usage (go_after, for example).
  • Where client-side build tooling fits.
  • Dependency injection and logic files (lazy loading).
  • Database access.
  • Object oriented alternatives to GLOBAL usage.

A minimal example project can be shown with page/index.html and how to manipulate the page in page/index.php.

Next page: Getting started to get set up for development quickly.


Getting started:

  • I want to build my first webpage.
  • I want to make my page dynamic.
  • I want to build an API.
  • I want to update part of a page.
  • I want reusable page parts.

Next page: information about installation on different platforms, or using gt commands


Installation:


gt commands:


Blueprints:


After this, Tutorials section.


User guide:

  • Request-response lifecycle
  • Running your application (gt run = serve + build + cron)
  • Project layout
  • Application architecture
  • Web servers (inbuilt, nginx, lighttpd, apache)
  • URIs
  • Page View
  • Dynamic URIs
  • Headers and footers
  • Partial template pages
  • Page Logic
  • Protected globals
  • User input
  • Cookies
  • Sessions
  • Dynamic pages with the DOM
  • Custom HTML components
  • Database
  • Client side assets
  • API development
  • Security
  • Configuration
  • Client side build system
  • Coding styleguide

Further reading:

  • Distinct Logic Authority
  • SPA, MPA and Hypermedia (SPAs break hypermedia, MPAs often have less UX, multi-pass rendering)
  • Fluid User Experience with Flux
  • Speed & benchmarks
  • Caching
  • Service workers
  • Repository-Entity pattern

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the proposed minimal example in page/index.html and page/index.php, then inspect the existing documentation structure before organizing the listed topics. The issue spans getting started, installation, user guide, tutorials, and further reading, so done means the requested sections and explanations are documented with appropriate links and examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.