https://github.com/elephant418/staq
Staq is a modern & innovative PHP framework for enjoyable web development.
https://github.com/elephant418/staq
Last synced: 2 months ago
JSON representation
Staq is a modern & innovative PHP framework for enjoyable web development.
- Host: GitHub
- URL: https://github.com/elephant418/staq
- Owner: Elephant418
- License: mit
- Created: 2012-01-17T13:25:51.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2017-09-22T12:56:34.000Z (over 7 years ago)
- Last Synced: 2025-02-08T20:15:34.815Z (3 months ago)
- Language: PHP
- Homepage:
- Size: 1.47 MB
- Stars: 11
- Watchers: 6
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Staq [](https://travis-ci.org/Elephant418/Staq?branch=master)
======
Staq is a modern & innovative PHP framework for enjoyable web development.
1. [Features](#features)
2. [Let's code](#lets-code)
3. [How to Install](#how-to-install)
4. [How to Contribute](#how-to-contribute)
5. [Author & Community](#author--community)
Features
--------
Staq contains all the expected features : Extensible structure, routing, ORM, templating & pre-coded applications ( *Planned* ).
It mainly contains a new object pattern, *the stack*, for low dependency, high extensible & enjoyable development !
[↑ top](#readme)
Let's code
--------
### Hello world tutorial
```php
require_once( 'vendor/Elephant418/staq/src/include.php' );
\Staq\App::create( )
->addController( '/hello/:name', function( $name ) {
return 'Hello ' . $name;
} )
->run( );
```
### Hello world projects
You can use the Hello World projects to bootstrap an application:
* The simplest [Staq Hello World project](https://github.com/Elephant418/Staq-HelloWorld/)
* The [Staq Hello World project with MVC structure](https://github.com/Elephant418/Staq-HelloWorldMVC/)
### System Requirements
You need **PHP >= 5.4** and some happiness.
[↑ top](#readme)
How to Install
--------
If you don't have composer, you have to [install it](http://getcomposer.org/doc/01-basic-usage.md#installation).
Add or complete the composer.json file at the root of your repository, like this :
```json
{
"require": {
"Elephant418/staq": "0.6.0"
}
}
```
Staq can now be [downloaded via composer](http://getcomposer.org/doc/01-basic-usage.md#installing-dependencies).
The framework and the extensions work with the composer autoload:
```php
require_once( './vendor/autoload.php' );
```
[↑ top](#readme)
How to Contribute
--------
1. Fork the Staq repository
2. Create a new branch for each feature or improvement
3. Send a pull request from each feature branch to the **develop** branch
If you don't know much about pull request, you can read [the Github article](https://help.github.com/articles/using-pull-requests).
All pull requests must follow the [PSR2 standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) and be accompanied by passing [phpunit](https://github.com/sebastianbergmann/phpunit/) tests.
[↑ top](#readme)
Author & Community
--------
Staq is under [MIT License](http://opensource.org/licenses/MIT).
It is created and maintained by [Thomas ZILLIOX](http://tzi.fr).
If you have a question, you can send a message to the community via [the mailing list](mailto:[email protected]).
If you are curious on the next features, you can see my [trello board](https://trello.com/board/staq/50de3fe18942735c620000a9).
[↑ top](#readme)