Skip to content

Commit

Permalink
readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
muhammetsafak committed Dec 16, 2023
1 parent f0b0a33 commit e28b72b
Show file tree
Hide file tree
Showing 48 changed files with 664 additions and 35 deletions.
60 changes: 60 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# InitPHP Framework3

InitPHP Framework, is the most minimalist web framework manager using MVC architecture.

[![Latest Stable Version](http://poser.pugx.org/initphp/framework3/v)](https://packagist.org/packages/initphp/framework3) [![Total Downloads](http://poser.pugx.org/initphp/framework3/downloads)](https://packagist.org/packages/initphp/framework3) [![Latest Unstable Version](http://poser.pugx.org/initphp/framework3/v/unstable)](https://packagist.org/packages/initphp/framework3) [![License](http://poser.pugx.org/initphp/framework3/license)](https://packagist.org/packages/initphp/framework3) [![PHP Version Require](http://poser.pugx.org/initphp/framework3/require/php)](https://packagist.org/packages/initphp/framework3)

This framework offers only the most essential infrastructure tools and structure. Although it is minimalist, the most basic libraries it offers have the ability to compete with large frameworks.

### What does it offer?

It offers basic libraries that every project needs, such as Configurations, HTTP Routing, Database Abstraction and ORM, Multi-Language Support, Triggerable Events, User Inputs, Logger, Validation.

If you need more; You can simply integrate any Init PHP library or a different library into your project.

## Installation

```
composer create-project initphp/framework3 MyProject
php init key:generate
```

## Usage

It has a file and directory structure similar to the MVC frameworks that developers are used to. The classes and libraries of your application are in the `/application/` directory.

**_Note :_** If your project runs in a subdirectory, specify it in the `BASE_PATH` configuration in the `/.env` file.

You can find Route and other definitions in files and classes in the `/routes/` directory.

To see the available console commands;

```
php init list
```

## To-Do

-[ ] Detailed documentation or Wiki will be prepared.

## Getting Help

If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.

## Contributing

> All contributions to this project will be published under the MIT License. By submitting a pull request or filing a bug, issue, or feature request, you are agreeing to comply with this waiver of copyright interest.
- Fork it ( https://github.com/InitPHP/Framework3/fork )
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am "Add some feature")
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request

## Credits

- [Muhammet ŞAFAK](https://www.muhammetsafak.com.tr) <<[email protected]>>

## License

Copyright © 2022 [MIT License](./LICENSE)
14 changes: 13 additions & 1 deletion system/Application.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
<?php

/**
* InitPHP Framework
*
* This file is part of InitPHP.
*
* @author Muhammet ŞAFAK <[email protected]>
* @copyright Copyright © 2023 InitPHP Framework
* @license http://initphp.github.io/license.txt MIT
* @version 3.0
* @link https://www.muhammetsafak.com.tr
*/

declare(strict_types=1);
namespace InitPHP\Framework;

use InitPHP\Framework\Providers\{BootstrapServiceProvider,
Expand Down
12 changes: 12 additions & 0 deletions system/Base.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
<?php
/**
* InitPHP Framework
*
* This file is part of InitPHP.
*
* @author Muhammet ŞAFAK <[email protected]>
* @copyright Copyright © 2023 InitPHP Framework
* @license http://initphp.github.io/license.txt MIT
* @version 3.0
* @link https://www.muhammetsafak.com.tr
*/

declare(strict_types=1);
namespace InitPHP\Framework;

use InitPHP\Framework\Database\Database;
Expand Down
15 changes: 12 additions & 3 deletions system/Console/Command.php
Original file line number Diff line number Diff line change
@@ -1,10 +1,19 @@
<?php
/**
* InitPHP Framework
*
* This file is part of InitPHP.
*
* @author Muhammet ŞAFAK <[email protected]>
* @copyright Copyright © 2023 InitPHP Framework
* @license http://initphp.github.io/license.txt MIT
* @version 3.0
* @link https://www.muhammetsafak.com.tr
*/

declare(strict_types=1);
namespace InitPHP\Framework\Console;

use InitPHP\Console\Input;
use InitPHP\Console\Output;

abstract class Command extends \InitPHP\Console\Command
{
}
14 changes: 13 additions & 1 deletion system/Console/Commands/KeyGenerateCommand.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
<?php

/**
* InitPHP Framework
*
* This file is part of InitPHP.
*
* @author Muhammet ŞAFAK <[email protected]>
* @copyright Copyright © 2023 InitPHP Framework
* @license http://initphp.github.io/license.txt MIT
* @version 3.0
* @link https://www.muhammetsafak.com.tr
*/

declare(strict_types=1);
namespace InitPHP\Framework\Console\Commands;

use InitPHP\Framework\Console\Utils\ChangeDotEnv;
Expand Down
17 changes: 14 additions & 3 deletions system/Console/Commands/MakeCommandCommand.php
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
<?php

/**
* InitPHP Framework
*
* This file is part of InitPHP.
*
* @author Muhammet ŞAFAK <[email protected]>
* @copyright Copyright © 2023 InitPHP Framework
* @license http://initphp.github.io/license.txt MIT
* @version 3.0
* @link https://www.muhammetsafak.com.tr
*/

declare(strict_types=1);
namespace InitPHP\Framework\Console\Commands;

use InitPHP\Console\Input;
use InitPHP\Console\Output;
use \InitPHP\Console\{Input, Output};
use InitPHP\Framework\Console\Command;
use InitPHP\Framework\Console\Utils\MakeFile;

Expand Down
14 changes: 13 additions & 1 deletion system/Console/Commands/MakeControllerCommand.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
<?php

/**
* InitPHP Framework
*
* This file is part of InitPHP.
*
* @author Muhammet ŞAFAK <[email protected]>
* @copyright Copyright © 2023 InitPHP Framework
* @license http://initphp.github.io/license.txt MIT
* @version 3.0
* @link https://www.muhammetsafak.com.tr
*/

declare(strict_types=1);
namespace InitPHP\Framework\Console\Commands;

use InitPHP\Framework\Console\Utils\MakeFile;
Expand Down
12 changes: 12 additions & 0 deletions system/Console/Commands/MakeEntityCommand.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
<?php
/**
* InitPHP Framework
*
* This file is part of InitPHP.
*
* @author Muhammet ŞAFAK <[email protected]>
* @copyright Copyright © 2023 InitPHP Framework
* @license http://initphp.github.io/license.txt MIT
* @version 3.0
* @link https://www.muhammetsafak.com.tr
*/

declare(strict_types=1);
namespace InitPHP\Framework\Console\Commands;

use InitPHP\Framework\Console\Utils\MakeFile;
Expand Down
14 changes: 13 additions & 1 deletion system/Console/Commands/MakeMiddlewareCommand.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
<?php

/**
* InitPHP Framework
*
* This file is part of InitPHP.
*
* @author Muhammet ŞAFAK <[email protected]>
* @copyright Copyright © 2023 InitPHP Framework
* @license http://initphp.github.io/license.txt MIT
* @version 3.0
* @link https://www.muhammetsafak.com.tr
*/

declare(strict_types=1);
namespace InitPHP\Framework\Console\Commands;

use InitPHP\Framework\Console\Utils\MakeFile;
Expand Down
12 changes: 12 additions & 0 deletions system/Console/Commands/MakeModelCommand.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
<?php
/**
* InitPHP Framework
*
* This file is part of InitPHP.
*
* @author Muhammet ŞAFAK <[email protected]>
* @copyright Copyright © 2023 InitPHP Framework
* @license http://initphp.github.io/license.txt MIT
* @version 3.0
* @link https://www.muhammetsafak.com.tr
*/

declare(strict_types=1);
namespace InitPHP\Framework\Console\Commands;

use InitPHP\Framework\Console\Utils\MakeFile;
Expand Down
14 changes: 13 additions & 1 deletion system/Console/Commands/MakeProviderCommand.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
<?php

/**
* InitPHP Framework
*
* This file is part of InitPHP.
*
* @author Muhammet ŞAFAK <[email protected]>
* @copyright Copyright © 2023 InitPHP Framework
* @license http://initphp.github.io/license.txt MIT
* @version 3.0
* @link https://www.muhammetsafak.com.tr
*/

declare(strict_types=1);
namespace InitPHP\Framework\Console\Commands;

use InitPHP\Framework\Console\Utils\MakeFile;
Expand Down
14 changes: 13 additions & 1 deletion system/Console/Commands/MakeRequestCommand.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
<?php

/**
* InitPHP Framework
*
* This file is part of InitPHP.
*
* @author Muhammet ŞAFAK <[email protected]>
* @copyright Copyright © 2023 InitPHP Framework
* @license http://initphp.github.io/license.txt MIT
* @version 3.0
* @link https://www.muhammetsafak.com.tr
*/

declare(strict_types=1);
namespace InitPHP\Framework\Console\Commands;

use InitPHP\Framework\Console\Utils\MakeFile;
Expand Down
12 changes: 12 additions & 0 deletions system/Console/Commands/RouteListCommand.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
<?php
/**
* InitPHP Framework
*
* This file is part of InitPHP.
*
* @author Muhammet ŞAFAK <[email protected]>
* @copyright Copyright © 2023 InitPHP Framework
* @license http://initphp.github.io/license.txt MIT
* @version 3.0
* @link https://www.muhammetsafak.com.tr
*/

declare(strict_types=1);
namespace InitPHP\Framework\Console\Commands;

use InitPHP\Framework\Base;
Expand Down
14 changes: 13 additions & 1 deletion system/Console/Commands/ServeCommand.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
<?php

/**
* InitPHP Framework
*
* This file is part of InitPHP.
*
* @author Muhammet ŞAFAK <[email protected]>
* @copyright Copyright © 2023 InitPHP Framework
* @license http://initphp.github.io/license.txt MIT
* @version 3.0
* @link https://www.muhammetsafak.com.tr
*/

declare(strict_types=1);
namespace InitPHP\Framework\Console\Commands;

use \InitPHP\Console\{Input, Output};
Expand Down
15 changes: 13 additions & 2 deletions system/Console/Commands/StorageLinkCommand.php
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
<?php
/**
* InitPHP Framework
*
* This file is part of InitPHP.
*
* @author Muhammet ŞAFAK <[email protected]>
* @copyright Copyright © 2023 InitPHP Framework
* @license http://initphp.github.io/license.txt MIT
* @version 3.0
* @link https://www.muhammetsafak.com.tr
*/

declare(strict_types=1);
namespace InitPHP\Framework\Console\Commands;

use InitPHP\Console\Input;
use InitPHP\Console\Output;
use \InitPHP\Console\{Input, Output};
use InitPHP\Framework\Console\Command;

class StorageLinkCommand extends Command
Expand Down
14 changes: 13 additions & 1 deletion system/Console/Commands/ViewCacheClearCommand.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
<?php

/**
* InitPHP Framework
*
* This file is part of InitPHP.
*
* @author Muhammet ŞAFAK <[email protected]>
* @copyright Copyright © 2023 InitPHP Framework
* @license http://initphp.github.io/license.txt MIT
* @version 3.0
* @link https://www.muhammetsafak.com.tr
*/

declare(strict_types=1);
namespace InitPHP\Framework\Console\Commands;

use \InitPHP\Console\{Input, Output};
Expand Down
14 changes: 13 additions & 1 deletion system/Console/Utils/ChangeDotEnv.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
<?php

/**
* InitPHP Framework
*
* This file is part of InitPHP.
*
* @author Muhammet ŞAFAK <[email protected]>
* @copyright Copyright © 2023 InitPHP Framework
* @license http://initphp.github.io/license.txt MIT
* @version 3.0
* @link https://www.muhammetsafak.com.tr
*/

declare(strict_types=1);
namespace InitPHP\Framework\Console\Utils;

class ChangeDotEnv
Expand Down
13 changes: 12 additions & 1 deletion system/Console/Utils/MakeFile.php
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@
<?php
/**
* InitPHP Framework
*
* This file is part of InitPHP.
*
* @author Muhammet ŞAFAK <[email protected]>
* @copyright Copyright © 2023 InitPHP Framework
* @license http://initphp.github.io/license.txt MIT
* @version 3.0
* @link https://www.muhammetsafak.com.tr
*/

declare(strict_types=1);
namespace InitPHP\Framework\Console\Utils;

class MakeFile
{

protected string $template;

public function __construct(string $path)
Expand Down
Loading

0 comments on commit e28b72b

Please sign in to comment.