انتقل إلى المحتوى

SmartyURL Developer's Guide

Server Requirements

  • You need a web hosting account (for a domain or sub-domain) with PHP 8.1 or higher support and the following PHP extensions (typically supported by most PHP hosting providers):

  • Your web hosting account should have MySQL 8.0+ support

Installation

Currently, as SmartyURL is in its early stages, you can only install it using Composer. Once we release the first official version of SmartyURL, we will offer detailed installation instructions for other methods.

install SmartyURL using Composer:

composer create-project extendy/smartyurl:dev-main myapp
cd myapp
composer install
cp env .env

When using Composer, you can update SmartyURL dependencies in the future using composer update. However, for updating SmartyURL itself, manual updates or reinitializing the Composer project are necessary.

Or install with git

For Extendy developers or Developers who prefer to keep SmartyURL up to date using Git rather than Composer, you can install it by running::

git clone https://github.com/Extendy/SmartyURL.git myapp
cd myapp
composer install
cp env .env

Note

When installing SmartyURL with git, you gain the flexibility to easily update SmartyURL in the future using git fetch and git pull. However, it's worth noting that using git may provide bleeding-edge releases, which might not be as stable or thoroughly tested. Therefore Installing SmartyURL using git is recommended for experienced or Extendy developers only.

After installing the files

Ensure that you've created a MySQL database, then proceed to edit the .env file. Update the database configuration and make any necessary changes to tailor the other settings to your specific requirements.

Next, execute the 'migrate' command to import the database structure into your created database using:

php spark migrate --all

Then you need to create the first user:

You can create a new user by running:

php spark shield:user create

or by visiting your website and register new user

Ensure the user you've created is designated as a superadmin by modifying the auth_groups_users database table. Set the user's group name to 'superadmin' instead of 'user' for the created user using phpMyAdmin or any mysql client and make sure the user status is active by set active to 1 in users tables. or you have to verify the email next time you login.

Afterward, you can disable new user registration by editing the .env file. Make sure to set Auth.allowRegistration to 'false'. If it's not already present in your .env file, you can add it like this:

Auth.allowRegistration = false

When logged in, you might be prompted to verify your email to activate your account. Please check your email for a verification link. If you are unable to access your email or SmartyURL unable to send emails, you can manually set the 'active' value to 1 in the 'users' database table for the user you've created.