PHPackages                             pecee/simple-router-demo - 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. [Utility &amp; Helpers](/categories/utility)
4. /
5. pecee/simple-router-demo

ActiveProject[Utility &amp; Helpers](/categories/utility)

pecee/simple-router-demo
========================

Simple router demo project

5.0(3y ago)304314[1 issues](https://github.com/skipperbent/simple-router-demo/issues)MITPHPPHP &gt;=7.1

Since Feb 25Pushed 3y ago6 watchersCompare

[ Source](https://github.com/skipperbent/simple-router-demo)[ Packagist](https://packagist.org/packages/pecee/simple-router-demo)[ RSS](/packages/pecee-simple-router-demo/feed)WikiDiscussions master Synced 1w ago

READMEChangelog (1)Dependencies (1)Versions (3)Used By (0)

simple-router demo project
==========================

[](#simple-router-demo-project)

Notes
-----

[](#notes)

This project is here to give you a basic understanding of how to setup and using simple-php-router.

You can find the documentation for simple-php-router here:

Please note that this demo-project only covers how to integrate the `simple-router` in a project without a framework. If you are using some sort of PHP framework in your project the implementation might vary.

**What we won't cover:**

- How to setup a solution that fits your need. This is a basic demo to help you get started.
- Understanding of MVC; including Controllers, Middlewares or ExceptionHandlers.
- How to integrate into third party frameworks.

**What we cover:**

- How to get up and running fast - from scratch.
- How to get ExceptionHandlers, Middlewares and Controllers working.
- How to setup your webservers.

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

[](#installation)

- Install `simple-php-router` library with composer by running

```
composer install

```

- Navigate to the `demo-project` folder in terminal and run `composer update` to install the latest version.
- Point your webserver to `demo-project/public`.

### Setting up Nginx

[](#setting-up-nginx)

If you are using Nginx please make sure that url-rewriting is enabled.

You can easily enable url-rewriting by adding the following configuration for the Nginx configuration-file for the demo-project.

```
location / {
    try_files $uri $uri/ /index.php?$query_string;
}

```

### Setting up Apache

[](#setting-up-apache)

Nothing special is required for Apache to work. We've include the `.htaccess` file in the `public` folder. If rewriting is not working for you, please check that the `mod_rewrite` module (htaccess support) is enabled in the Apache configuration.

Folder structure
----------------

[](#folder-structure)

FolderDescriptionroutesFolder contains the files with our custom routes.appContains projects-specific PHP classes.publicPublic folder which are accessible through the web.Notes
-----

[](#notes-1)

The demo project has it's own `Router` class implementation which extends the `SimpleRouter` class with further functionality. This class can be useful adding additional functionality that are required before and after routing occurs or any extra functionality belonging to the router itself.

In this project we also use our custom router-class to autoload the `routes.php` file from our custom location (`app/routes.php`).

Please check the `routes.php` file in `demo-project/app` for all the urls/rules available in the project.

### CSRF-verifier

[](#csrf-verifier)

For the purpose of this demo, we've added a custom CSRF-verifier middleware called `CsrfVerifier` and disabled CSRF checks for all calls to `/api/*`. This will ensure that CSRF form-checks are not applied when calling our demo api url.

### Exception handlers

[](#exception-handlers)

The included `CustomExceptionHandler` class returns a very basic json response for errors received on calls to `/api/*` or otherwise just a simple formatted error response.

### Middlewares

[](#middlewares)

`ApiVerification` class is added to all calls to `/api/*`. This simple class just adds some data to the `Request` object, which is returned in one of the methods in the `ApiController` class. We've added this class to demonstrate that you can use middlewares to ensure that the user has the correct authentication - before router loads the controller itself.

### Urls

[](#urls)

Please see `routes.php` for all routes and rules.

URL//api/demo/companies/companies/\[id\]/contactThe MIT License (MIT)
---------------------

[](#the-mit-license-mit)

Copyright (c) 2016 Simon Sessingø / simple-router

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance19

Infrequent updates — may be unmaintained

Popularity21

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

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

Unknown

Total

1

Last Release

1178d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/2dab716ac4ac16ea3e01400efe43853b43821b33b8c601c2c772689d58cebf3c?d=identicon)[sessingo](/maintainers/sessingo)

---

Top Contributors

[![skipperbent](https://avatars.githubusercontent.com/u/634762?v=4)](https://github.com/skipperbent "skipperbent (17 commits)")

---

Tags

demopeceephp-routerrouter-demophpsimple-routerphp-simple-router

### Embed Badge

![Health badge](/badges/pecee-simple-router-demo/health.svg)

```
[![Health](https://phpackages.com/badges/pecee-simple-router-demo/health.svg)](https://phpackages.com/packages/pecee-simple-router-demo)
```

###  Alternatives

[imanghafoori/laravel-anypass

A minimal yet powerful package to help you in development.

21421.6k](/packages/imanghafoori-laravel-anypass)

PHPackages © 2026

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