Home

Welcome to the wiki!

This is the home page of the wiki, where you can find all the information you need to get started.

I am currently working on the documentation. If you have any questions, feel free to reach out to me on Twitter.

Completion status: 100% (18/18) (Except tutorials) Tutorials status: 0% (0/5)

Navigation

• Home
• App
  • Tutorials
  • Configuration
  • Controllers
  • Handlers
  • Helpers
  • Libraries
  • Models
  • Routes
  • Views
• Core
  • Router
  • Controller
  • Router
  • Loader
• CLI
  • Commands
  • Usage
• Libraries
  • Benchmark
  • Request
  • Response
  • Fuse
  • Sorm
• Getting started
  • Prerequisites
  • Installation
  • Configuration
  • Using CLI to generate code
  • Running the application in development mode
  • Contributing

Getting started

Prerequisites

To use the framework, you need to have the following installed:

• Php 8
  • Enable the following extensions:
    • pdo
    • sqlite3

Installation

To install the framework, you need to clone the repository.

git clone https://github.com/devsimsek/project-sdf
cd project-sdf

Configuration

To configure the framework, navigate into index.php and app/config/app.php.

Using CLI to generate code

With version v1.5 you can use the CLI to generate code.

CLI requires php to be installed on your system and added to the PATH.

To generate a controller, run the following command:

./sdf/cli g controller <controller_name>

To generate a model, run the following command:

Version v1.5 uses Sorm\Model as the default model class. You can change this by removing use SDF\Sorm\Model and adding use SDF\Model.

./sdf/cli g model <model_name>

To generate a migration, run the following command:

./sdf/cli g migration <migration_name>

You can use ./sdf/cli g migration <migration_name> from-model to generate a migration from a model. Migration name needs to be the same as the model name.

Running the application in development mode

To run the application in development mode, you can use the built-in PHP server.

php -S localhost:8000

or you can use the following command to run the application in development mode:

./sdf/cli serve

Contributing

To contribute to the project, you can fork the repository and create a pull request.