Getting Started on Square Cloud with PHP
Learn how to get started on Square Cloud with PHP
🚀 Introduction
- Before you begin, make sure you have PHP on your system. If you don’t have them yet, you can download them from the official PHP website.
- Next, you will need to create an account on Square Cloud, which can be done through the login page. You can use either your email or Discord, or both, to create an account.
- Finally, you need to have an active paid plan on your account. You can view our plans and purchase one according to your needs here.
⚙️ Creating the squarecloud config file
Learn about: how to make the configuration file for Square Cloud.
The squarecloud.app file is a configuration file that will be used to configure your application; it will be used to define the name, description, version, main file, among other things.
📄 Required Files
- index.php (Example of main file).
composer.json(*Optional dependency file).- squarecloud.app (a file containing your Square Cloud configuration).
▶️ Start Application
-
If the
STARTfield is not defined in the configuration file, a local PHP server will be started using thephp -S 0.0.0.0:80command. If theSTARTfield is defined in the configuration file, the value in theSTARTfield will be executed directly. For more information on configuration file parameters, visit configuration parameters. -
If the
composer.jsonfile exists, all dependencies will be installed using thephp composer.phar installcommand.
🖥️ Preparing Project for Upload
Before you can host your project on Square Cloud, ensure your project files are correctly configured for hosting.
If your project includes a composer.json file, Square Cloud will automatically install dependencies using Composer. However, if your project also has Node dependencies (i.e., a package.json file), you should specify the installation process in the START field of your squarecloud.app file. For example:
squarecloud.app/.config) file must be located in the root of the zip file. Otherwise, Square Cloud will not be able to find it during deployment.📤 Uploading Project to Square Cloud
After preparing your project files, you can now upload them to Square Cloud and host your project.
Access the Square Cloud Dashboard and upload your project files.
Access the Square Cloud Dashboard and upload your project files.
First Step
First, you need to have the CLI installed in your environment. If you don’t have it yet, run the following command in your terminal:
If you already have it, we recommend updating it. To do this, run the following command in your terminal:
Second Step
Now, to authenticate and use other CLI commands, you will find your authorization key here by clicking on “Request API Key”. After obtaining your authorization key, run the following command:
Third Step
Finally, to deploy your application to Square Cloud using the CLI, you need to execute the following command, passing the path of your zip file:
If you continue to experience any issues, please don’t hesitate to contact our support team.