Skip to content

Commit

Permalink
Adds in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Cameron Manderson committed Sep 21, 2014
1 parent 305a0fe commit e28a93f
Showing 1 changed file with 23 additions and 12 deletions.
35 changes: 23 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ PHP implementation of Struts in current framework interoperability group standar
![Travis build status master](https://travis-ci.org/cammanderson/phruts.svg?branch=master)
[![Coverage Status](https://coveralls.io/repos/cammanderson/phruts/badge.png?branch=master)](https://coveralls.io/r/cammanderson/phruts?branch=master)

* Run through Silex (e.g. get Dependency Injection, dispatcher, security, etc and support building up of other services)
* Run through Silex (e.g. get Dependency Injection, dispatcher, security, cache, esi, etc and support building up of other services)
* Uses Symfony HTTPFoundation/HTTPKernel
* Implements PSR's (Naming Conventions, Logging, Autoloading)
* Use Twig or your other preference dependencies

What is Phruts?
---------------
Phruts is based on Apache Struts, a Java MVC framework. Your controllers are configured through an XML file, which then also controls application flow and forwarding.
Phruts is based on Apache Struts, a Java MVC framework. Your controllers are configured through an XML file, which then also controls application flow and forwarding. Some parts are OK, some parts are much better done by other frameworks.

Install
-------
Expand Down Expand Up @@ -85,17 +85,28 @@ Create your app/config/web-config.xml
</action-mappings>
</phruts-config>
```

Extra things:
* Create your ```app/cache``` folder (this is a config option)
* Create a twig template ```app/Resources/views/welcome.html.twig```


Prelim Dev Stages
-----------------
* Initial port of Struts 1.2+ into PSR (underway)
* Code Coverage 35%+ (done)
* Finalise ActionKernel for mounting on Silex\Application (underway)
* Silex bootstrap with example
* Getting started documentation
* Code Coverage 70%+
* Port include 1.3.10 source
Feature support:
* Error handlers
* Global forwards
* Request Processor based on roles defined by Symfony Security
* Action forwards (internal action chaining)
* Wildcard path matching
* Action switching and multiple module support
* Multiple module config merging (e.g. multi config.xml)
* Struts 1.2 API

Current Development Status
--------------------------
* COMPLETE: Code Coverage 35%+
* COMPLETE: Code Coverage 75%+
* COMPLETE: Finalise ActionKernel for mounting on Silex\Application
* UNDERWAY: Confirm Struts 1.2 code coverage for framework features
* TODO: Documentation on working with Silex
* Struts 1.3 framework features

Why do this? Best way to learn techniques in web development is through studying Request->Response web frameworks. I have a soft-spot for the old Struts application, and we have legacy PHPMVC code which we would like to easily move forward. This project makes it easy for us to port that legacy code and modernise it fast by implementing PSR's, giving that code base a future supported life.

0 comments on commit e28a93f

Please sign in to comment.