Introduction

AssegaiPHP is a complete server-side web framework that enables you to create clean, powerful and efficient PHP applications in a fraction of the time by utilizing the latest features of the language.

Philosophy

We believe in the power of simplicity and efficiency. That's why we've designed our framework to be as intuitive and straightforward as possible, taking inspiration from successful frameworks like NestJS and Angular.

Our goal is to provide a comprehensive and modern toolkit for PHP developers, one that allows them to get their applications up and running as quickly and easily as possible. Whether you're a seasoned developer or just starting out, we believe that AssegaiPHP has something to offer you.

Our framework is built on the philosophy of loosely coupled, easily maintainable code. We believe that by following this approach, developers can create applications that are more scalable and easier to test.

But AssegaiPHP isn't just about code – it's about community too. We believe in the power of open-source development, and we're dedicated to building a thriving community of developers who share our passion for creating high-quality applications.

So if you're looking for a modern, efficient, and scalable PHP framework, look no further than AssegaiPHP. We can't wait to see what you build with it!

Installation

To begin, you have the option to either use the Assegai CLI to set up the necessary structure for your project, or to clone a pre-made starter project. Both options will give you the same end result.

If you're a first-time user, it is recommended to use the Assegai CLI to create a new project. This will create a new directory for your project, and fill it with the basic Assegai files and supporting modules, providing a standard foundation for your project. In the following "First Steps" section, we will walk through this process using the Assegai CLI.

$ assegai new project-name
$ cd project-name
$ assegai serve

Alternatives

Alternatively, you can use Git to install the starter project:

$ git clone https://github.com/assegaiphp/starter.git project-name
$ cd project-name
$ composer install
$ composer run start

To access the project, open your web browser and go to http://localhost:5000/

Another option is to manually create a new project from the ground up by using composer to install the core and supporting files. With this method, you will need to create the project boilerplate files yourself.

$ composer require assegaiphp/core