README

⚡ Lightning-fast PHP Framework Installer

Installation • Usage • Commands • Requirements

About

Rapix Installer is a command-line tool designed to quickly scaffold new Rapix PHP Framework projects. With a single command, you can create a fully configured Rapix project with all dependencies installed and ready to go.

Requirements

PHP >= 8.3
Composer
Git

Installation

Install the Rapix Installer globally via Composer:

composer global require salehnevergiveup/rapix-installer

Make sure your global Composer bin directory is in your system's PATH. You can add it by including this in your shell configuration file (~/.bashrc, ~/.zshrc, etc.):

export PATH="$HOME/.composer/vendor/bin:$PATH"

After installation, verify it's working:

rapix version

Usage

Creating a New Project

To create a new Rapix project, use the new command followed by your desired project name:

rapix new my-awesome-project

This command will:

✅ Validate the project name
📁 Create a new directory with your project name
📦 Clone the Rapix framework repository
🔧 Install all Composer dependencies automatically

Example:

rapix new blog-api
cd blog-api

Commands

`new`

Create a new Rapix project.

rapix new <project-name>

Arguments:

<project-name> - The name of your new project (required)

Example:

rapix new ecommerce-platform

`version`

Display the current version of Rapix Installer.

rapix version

Output:

Rapix Installer v1.0.0

`help`

Display the help menu with all available commands.

rapix help

Output:

Rapix Installer - commands
  rapix new <project name>    create new project
  rapix version               list rapix versions
  rapix help                  list help list

Project Structure

After creating a new project, you'll have the following structure:

my-project/
├── app/
├── config/
├── public/
├── routes/
├── vendor/
├── composer.json
└── ...

Validation

The installer includes built-in validation to ensure smooth project creation:

✅ Checks if project name is provided
✅ Verifies the directory doesn't already exist
✅ Ensures all required commands (git, composer) are available

Troubleshooting

Command not found

If you receive a "command not found" error after installation:

Ensure Composer's global bin directory is in your PATH
Run composer global config bin-dir --absolute to find the directory
Add that directory to your PATH

Permission denied

If you encounter permission issues:

chmod +x ~/.composer/vendor/bin/rapix

Project already exists

If you try to create a project with a name that already exists in the current directory, the installer will notify you and abort the operation.

Development

Setting Up for Development

git clone https://github.com/salehnevergiveup/rapix-installer.git
cd rapix-installer
composer install

Running Tests

composer test

Code Formatting

composer format

Static Analysis

composer analyse

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Fork the repository
Create your feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add some amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author

Saleh Al-Dhaheri

Email: salehaldhaheri09@gmail.com
GitHub: @salehnevergiveup

Made with ❤️ by Saleh Al-Dhaheri

⚡ Build something amazing with Rapix!

salehnevergiveup / rapix-installer

Maintainers

Details