PHPackages                             szyminson/simple-website - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. szyminson/simple-website

AbandonedArchivedProject[Framework](/categories/framework)

szyminson/simple-website
========================

A simple micro-framework for simple websites.

v0.1.0(7y ago)013[3 issues](https://github.com/szyminson/simple-website/issues)MITPHP

Since Nov 29Pushed 7y ago1 watchersCompare

[ Source](https://github.com/szyminson/simple-website)[ Packagist](https://packagist.org/packages/szyminson/simple-website)[ Docs](https://github.com/szyminson/simple-website)[ RSS](/packages/szyminson-simple-website/feed)WikiDiscussions master Synced yesterday

READMEChangelogDependencies (4)Versions (3)Used By (0)

Simple Website
==============

[](#simple-website)

This project's goal is to create an easy in implementation and simple micro-enigne with blade theme support and text files based content management.

Table of Contents
------------------

[](#table-of-contents-)

- [Simple Website](#simple-website)
    - [Dependencies](#dependencies)
    - [Installation](#installation)
    - [Subpages](#subpages)
    - [Layout](#layout)
        - [File naming](#file-naming)
    - [Modules](#modules)
        - [Static Modules](#static-modules)
            - [File naming](#file-naming-1)
        - [Dynamic Modules](#dynamic-modules)
            - [Variables available in module's backend](#variables-available-in-modules-backend)
            - [File naming](#file-naming-2)
            - [ExampleModule.php](#examplemodulephp)
            - [ExampleModule.blade.php](#examplemodulebladephp)
        - [Components](#components)

Dependencies
------------

[](#dependencies)

- [eftec/bladeone](https://github.com/EFTEC/BladeOne)
- [vlucas/phpdotenv](https://github.com/vlucas/phpdotenv)
- [oomphinc/composer-installers-extender](https://github.com/oomphinc/composer-installers-extender)
- [erusev/parsedown](https://github.com/erusev/parsedown)

Installation
------------

[](#installation)

1. `composer create-project szyminson/simple-website projectName`,
2. Rename `.env.example` to `.env` and change `BASE_DIR` variable to your projects path,
3. Open your project in a browser and you should see an example page.

Advice
-------

[](#advice--)

The best way to understand how to use Simple Website is to dig through the files while reading this README file.

Subpages
--------

[](#subpages)

Subpage list is stored in `/public/content/pages.config` by default (you can change it's path in `.env` file). Remember to place subpages in the config file in order you want to see them in menu. First subpage from the file is automatically treated as a home page.

Layout
------

[](#layout)

Simple Website uses *BladeOne* templating engine. There are **3 types** of templates:

- Main Layout - a main part of your website's look, it's extended by sublayouts,
- Sublayout - this is a layout that is used by subpages, it extends main layouts,
- Module's layout - each module has it's own layout so you can easily change a look of the module.

Main and sub layouts are stored in `/views/layouts`. Modules' layouts are stored in `/views/modules`.

### File naming

[](#file-naming)

- Main and sub layouts: `/views/layouts/LayoutName.blade.php`
- Modules' layouts: `/views/modules/ModuleName.blade.php`

##### Note

[](#note-)

You can use [Asset Packagist](https://asset-packagist.org/) for your front-end dependencies. By default front-end assets will be stored in `/public/assets`.

Modules
-------

[](#modules)

Modules are simple parts which can be used to build your subpage. You can create **2 kinds** of modules:

### Static Modules

[](#static-modules)

Just simple modules containting only html code. You can create them by creating a blade template in `/views/modules`.

#### File naming

[](#file-naming-1)

`/views/modules/ModuleName.blade.php`

### Dynamic Modules

[](#dynamic-modules)

In dynamic modules you can use your **own php code**. For this purpose you have to create a php file in `/modules` as well as a blade template in `/views/modules`. You can pass data from the backend part of your module to the template by setting a `$Content` array.

#### Variables available in module's backend

[](#variables-available-in-modules-backend)

- `$pageId` - it's an id of current subpage,
- `$pages` - an object containting all info about your subpages,
- `$blade` - you can optionally load some additional templates into the `$Content` array but it's not recommended,
- `$parsedown` - you can use this object to parse some markdown into html.

#### File naming

[](#file-naming-2)

- Backend: `/modules/ModuleName.php`
- Frontend: `/views/modules/ModuleName.blade.php`

#### ExampleModule.php

[](#examplemodulephp)

```

```

#### ExampleModule.blade.php

[](#examplemodulebladephp)

```

  {{ $Example }}

  {{ $Example2 }}

  @foreach($Items as $Item)
  $Item
  @endforeach

```

### Components

[](#components)

Components are modules which can be placed in your **main** or **sublayout** ( for example *Menu* ). To use a module as a component you have to put it's name into a components' **config file** ( by default `/public/content/components.config` ). Then you can simply load the component into your layout file by using it's name: `{{ $Menu }}`.

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community4

Small or concentrated contributor base

Maturity52

Maturing project, gaining track record

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~3 days

Total

2

Last Release

2718d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/a1a00818035871bdaa9f2730807ff9b397d0b9823410d441b46fa616384a22c5?d=identicon)[szyminson](/maintainers/szyminson)

---

Tags

frameworkmicroSimplewebsiteszyminson

### Embed Badge

![Health badge](/badges/szyminson-simple-website/health.svg)

```
[![Health](https://phpackages.com/badges/szyminson-simple-website/health.svg)](https://phpackages.com/packages/szyminson-simple-website)
```

###  Alternatives

[phprest/phprest

PHP Rest Framework.

3049.3k](/packages/phprest-phprest)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
