Getting started

Installation

You can quickly create a Dominus api backends with the Dominus CLI. Before continuing, please make sure you have python and the pip module installed on your machine, the CLI depends on them to function :).

Start by cloning the CLI files from the main repository.

git clone https://github.com/daniel1919-00/DominusCli

Access the CLI using the starter scripts: dominus.sh for Linux/macOS or dominus.bat for Windows.

You may create a new project by changing the current directory to the desired path and using the new command.

new my-project

After the project has been created, you can access it either by installing a web server yourself, or using the docker configuration (if prompted yes when asked by the cli) from the Dominus framework which includes nginx with php8.1 and xdebug installed.

Optionally set the app namespace, by default it is App, this namespace is also used when creating components for your application (Modules, Controllers, Services, etc.)

Configuration

You can configure your app behaviour by checking out the configuration docs.

Directory Structure

A typical Dominus project directory looks something like this:

• App
  • Modules
    • Controllers
    • Models
    • Migrations
    • Repositories
    • Services
  • Services
  • Middleware
• Logs
• Tests
• Dominus

Logs

If you have set the APP_LOG_TO_FILE environment variable to 1 then all the logging done by the framework are stored (you can change the location by editing APP_LOG_FILE_LOCATION environment variable).

Tests

This is where all your test suites go, and where the testing framework looks for them.

Dominus

The Dominus framework system files are stored here and should not be modified.

Your first module

You are now ready to create your first module.