https://github.com/ag-sanjjeev/roots-php-framework
ROOTS are growing...
https://github.com/ag-sanjjeev/roots-php-framework
architecture controller framework micro model mvc oops pattern php roots routing singleton system view web
Last synced: 6 months ago
JSON representation
ROOTS are growing...
- Host: GitHub
- URL: https://github.com/ag-sanjjeev/roots-php-framework
- Owner: ag-sanjjeev
- License: mit
- Created: 2024-12-30T06:53:48.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-17T07:22:12.000Z (11 months ago)
- Last Synced: 2025-02-25T13:51:16.160Z (11 months ago)
- Topics: architecture, controller, framework, micro, model, mvc, oops, pattern, php, roots, routing, singleton, system, view, web
- Language: PHP
- Homepage:
- Size: 78.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ROOTS FRAMEWORK
**Simple as roots, Strong as foundation...**
One of the simplest MVC architecture based framework. Which is made on & for PHP. Who wants to test and start PHP based project with MVC architecture.
The concept and purpose of this framework is minimal and robust rather than bulky and fully loaded.
*The framework is independent of any third-party libraries, packages and plug-ins.*
## ☴ Overview:
1. [Installation](#-installation)
2. [Documentations](#-documentations)
3. [Contribution](#-contribution)
4. [Disclaimer](#-disclaimer)
5. [License](#-license)
6. [Contact](#-contact)
## ⚑ Installation:
Currently, This project is not available in any of the package managers.
To use this framework, Follow the installation process below:
**Requirements:**
- It requires PHP version 8.1 or higher.
- Git installed in the system.
- Composer installed in the system.
**Steps:**
- First create an empty project directory. Where this framework to be cloned.
- Move to the project directory and Initiate git repository.
- Fetch this framework latest changes with below command.
```bash
git fetch --depth 1 https://github.com/ag-sanjjeev/roots-php-framework.git
```
- Now, the repository has FETCH_HEAD, Then merge FETCH_HEAD to the current active branch by below command.
```bash
git merge FETCH_HEAD
```
**Post Installation:**
- Copy the `example.config.php` as `config.php` under `app\configurations`.
- Install composer dependencies and packages.
*For production:*
```bash
composer install --no-dev
```
*For development:*
```bash
composer install
```
- Initiate Composer Autoload with below command.
```bash
composer dump-autoload
```
## ⚑ Documentations:
For project documentations, Refer [DOCUMENTATIONS](DOCUMENTATIONS.md).
## ⚑ Contribution
Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request. Make sure to follow the existing coding style and provide clear documentation for your changes.
## ⚑ Disclaimer
This is a simple MVC architecture based PHP framework. It is developed for simplicity and utilize MVC architecture in PHP projects. Consult with experts, double check, test and verify the code that fits and works for your application logics, Before proceed in real-time implementations. This project will not give any claim and/or warranty for damages or loses by using this project in any of the form and in any of the versions.
## ⚑ License
This reference licensed under the [MIT license](LICENSE). Feel free to use, modify, and distribute it as per the terms of the license.
## ⚑ Contact
If you have any questions or need further assistance, please feel free to reach me by referring [My Github Profile](https://github.com/ag-sanjjeev/)
Thanks for reviewing this project!