README

🚀 A Platform for Soaring

Warning

This Project is Under Construction

It's not a Stable and Reliable Version. Please do not use it in Production Environment.

Development Plan

Core utility components (Oct 2023)
Routing, Request and Response, Middlewares, Controllers (Nov 2023)
Template Engine, Google Chrome Plugin (Dec 2023)
Database Connection, ORM (Jan 2024)
Release LTS Version 1.0.0 (March 2024)

Requirements

Sakoo Just needed Docker Platform to Run. Make sure Docker and Docker Compose are installed on your system. Windows users could use the Windows Subsystem for Linux (WSL-2) to Run the Project on Docker Desktop. See Windows WSL-2 Installation Guide.

Installation

Run the following command to initialize the Project:

make init

Once after the Project initialization, you can use following commands:

make up     # equals to docker-compose up -d
make down   # equals to docker-compose down
make rm     # removes the container's persist data

Sakoo uses a Docker Proxy Program, and it gives you ability to interact with your favorite tools, Easily. For Example:

./sakoo php <your command>
./sakoo composer <your command>
./sakoo test

Contributing

Thank you for considering contributing to the Sakoo framework! You can read our contribution guidelines Here

Code of Conduct

In order to ensure that the Sakoo community is welcoming to all, please review and abide by the Code of Conduct

Security Vulnerabilities

If you discover a security vulnerability within Sakoo, please send an email to Pouya Asgharnejad Tehran. All security vulnerabilities will be promptly addressed. You can read this complete Security Policy Guide.

License

The Sakoo PHP Framework is open-source software licensed under the MIT License.

sakoo / framework-core

Maintainers

Details