README

inception

A lightweight PHP based web framework built by Snaju Development
<br />
<a href="https://docs.dev.snaju.com/inception"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://git.hou.snaju.com/snaju-oss/inception/issues">Report Bug</a>
·
<a href="https://git.hou.snaju.com/snaju-oss/inception/issues">Request Feature</a>

About The Project

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

1. PHP ^7.4|^8.0
2. NodeJS ^14.16

Installation

1. Clone the repo

   git clone https://git.hou.snaju.com/snaju-oss/inception-framework.git
   

2. Install node dependencies

   npm install
   

3. Install composer dependencies

   composer install
   

4. Move .env-example to .env and create database and update details
5. If using port for php server other than 8888, update gulpfile.js line 29 with the proper port

Usage

• For dev you can use one of the npm scripts. npm run start will start a dev server that injects js/css for live reloading and refreshes when templates are updated. Note: If using an IDE like PHPStorm, updates to file system are delayed which means the reload is not triggered until the IDE is unfocused.

• If using port for php server other than 8888, update gulpfile.js line 29 with the proper port

// TODO

For more examples, please refer to the Documentation

Roadmap

• [X] File-based Routing System
• [X] Twig Rendering
• [X] Global & Route Middleware
• [X] Route Events (Start, Process, End, Fallback)
• [X] Basic Response Handling (view, json)
• [X] Request Validators
• [X] Exception Handling
• [X] Global Functions
• [] Plugins
• [] Auto API Adapters and Responses

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Snaju Development - @snajullc - dev@snaju.com

Project Link: https://git.hou.snaju.com/snaju-oss/inception

Acknowledgements

• PHP dotenv - .env file reader
• Doctrine ORM Quick Reference
• phpDocumentor - Generate docs from code