Ruben 8855a9b5be Update getting started documentation

Remove redundant quick start section
Simplify requirements and installation
Clarify local development setup
Streamline first page creation
Add shared hosting deployment instructions
Update tutorial content structure
Improve content format explanations
Clarify asset handling
Simplify metadata documentation
Update styling documentation
Improve template explanations
Remove unnecessary examples
Make documentation more concise

2026-02-07 19:14:13 +01:00

1.6 KiB

Raw Blame History

Getting Started

Requirements

PHP 8.4+
Apache with mod_rewrite
A text editor

Installation

git clone https://github.com/yourusername/folderweb.git
cd folderweb
cp -r app/default custom
mkdir content

Local Development

cd devel
podman-compose up -d

Or with PHP's built-in server:

php -S localhost:8080 -t .

Visit http://localhost:8080.

Your First Page

Create content/hello.md:

# Hello, World!

This is my first page.

Visit http://localhost:8080/hello/.

Deploying to Shared Hosting

Recommended Structure

Keep the framework and content outside the web root. Use symlinks to expose them:

/home/username/
├── folderweb/           # Git repo (not public)
│   ├── app/
│   └── custom/
├── content/             # Your content (not public)
└── public_html/         # Web root
    ├── app -> ../folderweb/app/
    ├── custom -> ../folderweb/custom/
    └── content -> ../content/

To update FolderWeb, git pull in the repo directory.

Apache

FolderWeb includes an .htaccess file that handles routing automatically. If your host requires manual configuration:

<Directory /path/to/public_html>
    RewriteEngine On
    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteRule ^(.*)$ /app/router.php [L,QSA]
</Directory>

Next Steps

Adding content — Pages, metadata, and content formats
Styling — Customize the look
Templates — Control how content is presented

1.6 KiB Raw Blame History