dillonsmart / tetherphp
TetherPHP is a PHP framework which ships as a skeleton application.
Installs: 11
Dependents: 0
Suggesters: 0
Security: 0
Stars: 17
Watchers: 1
Forks: 1
Open Issues: 0
Language:CSS
Type:project
Requires
- php: ^8.4
- dillonsmart/tetherphp-core: ^0.1.6
README
About TetherPHP
TetherPHP is a lightweight, flexible framework for building web applications in PHP using the ADR (Action-Domain-Responder) architecture. It provides a simple and intuitive way to structure your application, making it easy to develop and maintain.
Installation
You can install TetherPHP using Composer. Run the following command in your terminal:
composer create-project dillonsmart/tetherphp ./
Once installed, ensure you create a .env
file in the root of your project by copying the provided .env.example
file.
Then, run the following command to install the necessary dependencies:
composer install
Build Stylesheet using Tailwind
TetherPHP uses Tailwind CSS for styling. To build the stylesheet, run the following command in your terminal:
npm install && npx tailwindcss -i ./resources/css/app.css -o ./public/css/app.css --watch
Usage
To get started with TetherPHP, please refer to the documentation.
Local Development
For local development of TetherPHP and the core TetherPHP framework files tetherphp-core create a composer.local.json file, and add the following code to it:
{ "repositories": [ { "type": "path", "url": "../tetherphp-core" } ], "require": { "dillonsmart/tetherphp-core": "*" }, "minimum-stability": "dev", "prefer-stable": true }
Then run the following command in your terminal:
COMPOSER=composer.local.json composer update
You can also create an alias for the command to make it easier to run:
alias composer-local='COMPOSER=composer.local.json composer update'