README

About IronPHP

The IronPHP Framework 1.0 skeleton to create application which uses Front Controller, and MVC.

The Framework source code can be found here: ironphp/ironphp.

Note: No stable release yet - IronPHP Framework 1.0.13 alpha1 version has been released.

Table of Contents

• Requirements
• Installing IronPHP via Composer
• Update
• Configuration
• Community
• Get Support
• Security
• Credits
• License

Requirements

IronPHP requires PHP 7.2 or later; we recommend using the latest PHP version whenever possible.

Installing IronPHP via Composer

You can install IronPHP as your project using Composer as a starting point. you can run the following:

1. Download Composer-Setup.exe or download composer.phar file.
2. Run php composer.phar create-project --prefer-dist ironphp/app [dir_name].

If Composer is installed locally, run

$ php composer.phar create-project ironphp/app

If Composer is installed globally, run

$ composer create-project ironphp/app

In case you want to use a custom app dir name (e.g. /myapp/):

$ composer create-project --prefer-dist ironphp/app myapp

You can directly clone this repo:

$ git clone https://github.com/ironphp/app.git myapp

Go to myapp dir, if installed with myapp dirname:

$ cd myapp

Go to ironphp dir, if installed without dirname:

$ cd app

If you have cloned or downloaded this repo, then you have to manually create .env file and generate APP_KEY:

$ copy .env.example .env
$ php jarvis key

You can now use php developement webserver to view the default home page:

$ php jarvis serve

You can also use jarvis by shortcut for Windows (only work in cmd, not supported in Windows PowerShell, or Linux/MacOS terminal):

$ jarvis serve

Then visit http://localhost:8000 to see the welcome page.

Update

Since this is a starting point for your application and various files would have been modified as per your needs, there isn't a way to provide automated upgrades atleast for NOT FOR NOW, so you have to update for this app-skeleton manually.

You can update The Framework ironphp/ironphp easily:

$ composer update ironphp/ironphp

Configuration

Read and edit 'Configuraton' in config/app.php and setup the 'Datasource' in config/database.php.

Community

• IronPHP on GitHub
• Follow us on FaceBook

About Us

IronPHP development is led by the GaurangKumar.

Get Support

• GitHub Issues - Got issues? Please tell us!

Security

If you’ve found a security issue in IronPHP, please use the following procedure instead of the normal bug reporting system. Instead of using the bug tracker, mailing list or IRC please send an email to gaurangkumarp@gmail.com.

For each report, we try to first confirm the vulnerability. Once confirmed, the IronPHP will take the following actions:

• Acknowledge to the reporter that we’ve received the issue, and are working on a fix. We ask that the reporter keep the issue confidential until we announce it.
• Get a fix/patch prepared.
• Prepare a post describing the vulnerability, and the possible exploits.
• Release new versions of all affected versions.
• Prominently feature the problem in the release announcement.

Authors

• GaurangKumar | GitHub | Instagram | Facebook | Linkedin | Patreon | gaurangkumarp@gmail.com