Skip to content

CLI tool for installing the Simpl PHP framework automatically using npx.

Notifications You must be signed in to change notification settings

IJuanTM/simpl-installer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Simpl Installer

CLI tool for installing the Simpl PHP framework automatically using npx.

Usage

Install the Framework

Create a new Simpl project by running the following command, change my-project to your desired project name:

npx @ijuantm/simpl-install my-project

Or run without a project name to be prompted for one:

npx @ijuantm/simpl-install

The installer will:

  1. Download the latest framework version
  2. Create a new project directory
  3. Set up all necessary files and folders

Get Help

npx @ijuantm/simpl-install --help

Post-Installation Steps

After the installation completes, run the following commands:

cd my-project
composer install && npm install

For more details, see the README file in the project directory, or in the documentation.

Installing Add-ons

Once your framework is installed, you can add functionality with add-ons, for example, to install the "auth" add-on:

npx @ijuantm/simpl-addon auth

See available add-ons:

npx @ijuantm/simpl-addon --list

Requirements

  • Node.js: >= 22.x.x
  • PHP: >= 8.5.x
  • Composer: Latest version

About

CLI tool for installing the Simpl PHP framework automatically using npx.

Topics

Resources

Stars

Watchers

Forks