🚀 Introduction
- Before you begin, make sure you have Rust on your system. If you don’t have them yet, you can download them from the official Rust website.
- Next, you will need to create an account on Square Cloud, which can be done through the login page. You can use your email, GitHub, or both to create the 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
- main.rs (Example of main file).
- Cargo.toml (dependency file).
- squarecloud.app (file that contains the Square Cloud configuration).
▶️ Start Application
- If the
STARTfield is not defined in the configuration file, Square Cloud will run thecargo run --releasecommand to build and execute the code in release mode. 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.
🖥️ Preparing Project for Upload
Before hosting your project on Square Cloud, you must first have the files of your project properly configured, so that you can host it later.The configuration (
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.- Dashboard Upload
- CLI Upload
Access the Square Cloud
Dashboard and upload your project
files.