An open API service indexing awesome lists of open source software.

https://github.com/ironphp/app

IronPHP 1.0 application template
https://github.com/ironphp/app

app framework frontcontroller iron-php ironphp ironphp-app ironphp-framework mvc php

Last synced: 25 days ago
JSON representation

IronPHP 1.0 application template

Awesome Lists containing this project

README

          

IronPHP Application Skeleton




Total Downloads


Latest Stable Version


Software License


Minimum PHP Version




CircleCI Build status


AppVeyor Build status


TravisCI


StyleCI




Average time to resolve an issue


Percentage of issues still open

## 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](https://github.com/ironphp/ironphp).

> **Note:** No stable release yet - [IronPHP Framework 1.0.13 alpha1](https://github.com/ironphp/ironphp/releases/tag/1.0.13-alpha1) version has been released.

## Table of Contents

- [Requirements](#requirements)
- [Installing IronPHP via Composer](#installing-ironphp-via-composer)
- [Update](#update)
- [Configuration](#configuration)
- [Community](#community)
- [Get Support](#get-support)
- [Security](#security)
- [Credits](#credits)
- [License](#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](https://getcomposer.org) as
a starting point. you can run the following:

1. Download [Composer-Setup.exe](https://getcomposer.org/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

``` bash
$ php composer.phar create-project ironphp/app
```

If Composer is installed globally, run

``` bash
$ composer create-project ironphp/app
```

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

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

You can directly clone this repo:

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

Go to myapp dir, if installed with myapp dirname:

```bash
$ cd myapp
```

Go to ironphp dir, if installed without dirname:

```bash
$ cd app
```

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

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

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

```bash
$ 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):

```bash
$ jarvis serve
```

Then visit [http://localhost:8000](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:

``` bash
$ 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][1]
* Follow us on [FaceBook][2]

## About Us

IronPHP development is led by the [GaurangKumar](https://instagram.com/gaurangkumar1).

## Get Support

* [GitHub Issues](https://github.com/ironphp/app/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](https://github.com/gaurangkumar) | [Instagram](https://instagram.com/gaurangkumar1) | [Facebook](https://facebook.com/gaurangkumarp) | [Linkedin](https://www.linkedin.com/in/gaurangkumar/) | [Patreon](https://www.patreon.com/gaurangkumar) |

[1]: https://github.com/ironphp
[2]: https://www.facebook.com/IronPHP