PHPLucidFrame Documentation

This is the official documentation for the PHPLucidFrame project

Installation Requirement for Contribution

Install Python.

Install Sphinx with:

pip install -U Sphinx

Install Sphinx rtd theme with:

pip install sphinx_rtd_theme

And then try sphinx-build --version. If it doesn't work, add sphinx-build.exe path to the environment variables.

Generate HTML from rst files with:

make html

The generated HTML pages are in _build\html

Name		Name	Last commit message	Last commit date
_build		_build
_static		_static
_templates		_templates
images		images
.gitignore		.gitignore
.readthedocs.yaml		.readthedocs.yaml
Makefile		Makefile
README.md		README.md
about.rst		about.rst
ajax-and-javascript-api.rst		ajax-and-javascript-api.rst
application-structure.rst		application-structure.rst
authentication-and-authorization.rst		authentication-and-authorization.rst
auto-loading-libraries.rst		auto-loading-libraries.rst
bootstrapping.rst		bootstrapping.rst
conf.py		conf.py
configuration-and-parameters.rst		configuration-and-parameters.rst
core-defined-constants-variables.rst		core-defined-constants-variables.rst
creating-a-multilingual-site.rst		creating-a-multilingual-site.rst
database-configuration.rst		database-configuration.rst
database-seeding.rst		database-seeding.rst
file-helper.rst		file-helper.rst
file-inclusion.rst		file-inclusion.rst
form-and-validation.rst		form-and-validation.rst
helpers.rst		helpers.rst
hooks-and-overrides.rst		hooks-and-overrides.rst
index.rst		index.rst
installation.rst		installation.rst
list-with-pagination.rst		list-with-pagination.rst
make.bat		make.bat
middleware.rst		middleware.rst
native-queries.rst		native-queries.rst
query-builder.rst		query-builder.rst
requirements.txt		requirements.txt
schema-manager.rst		schema-manager.rst
the-lucidframe-console.rst		the-lucidframe-console.rst
the-view.rst		the-view.rst
url-routing.rst		url-routing.rst
working-with-data.rst		working-with-data.rst