PHPackages                             tivins/framework - 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. tivins/framework

ActiveLibrary[Framework](/categories/framework)

tivins/framework
================

PHP Framework for web applications

051PHP

Since Mar 16Pushed 4y ago1 watchersCompare

[ Source](https://github.com/tivins/framework)[ Packagist](https://packagist.org/packages/tivins/framework)[ RSS](/packages/tivins-framework/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

Framework
=========

[](#framework)

PHP framework for web applications

Requirements:

- PHP8.0+

Dependencies:

- [tivins/database](https://github.com/tivins/database) (facultative. Only if a database is used for the project)
- [erusev/parsedown](https://github.com/erusev/parsedown)

Usage
-----

[](#usage)

1. Install

    ```
    composer require tivins/framework
    ```
2. Prepare folders

    ```
    mkdir -p settings # create folder for settings files
    cp vendor/tivins/framework/references/reference.settings.php settings/my-app.test.settings.php # See settings
    echo "settings/" >> .gitignore # do not commit settings files
    mkdir -p htdocs/cache # public data and its cache dir
    mkdir -p pdata/cache # private data and its cache dir
    touch boot.php # see Boot
    touch htdocs/index.php # see Index
    ```
3. Init settings

    ```
    mkdir settings # create folder for settings files
    touch settings/my-app.test.settings.php
    ```

    Nota: Colons `:` are replaced by hyphens `-` in the host name (eg: if the hostname is `my-app.test:8080`, the settings filename should be `my-app.test-8080.settings.php`.

    Here is an example of the setting file:

    ```