Making your first deploy via Dashboard (Step-by-step)

Prerequisites

Before starting the process on the Dashboard, make sure you have:

An active and verified account on Square Cloud.
A plan with sufficient resources (RAM/CPU) for your application.
Your application code completed and tested locally.

1. Preparing Your Project

For Square Cloud to understand and run your project correctly, you need to ensure your file structure is appropriate.

The Configuration File (`squarecloud.app`)

This is the most important step. Every project must have a file named squarecloud.app in the root folder. It dictates how the infrastructure should handle your code.

Although our platform features a smart system for automatic configuration generation via the dashboard, nothing stops you from exercising your "power user" side. If you prefer to get ahead and configure the files manually, feel free: we appreciate and encourage this level of technical dedication! 😉

Basic example of a squarecloud.app for Node.js:

DISPLAY_NAME=My First App
DESCRIPTION=An amazing application running on Square Cloud
MAIN=index.js
MEMORY=512
VERSION=recommended

Dependency Files

Make sure the file listing your project's libraries is in the root directory:

Node.js: package.json
Python: requirements.txt
Java: pom.xml or build.gradle

Basically, remember to keep the dependency file that corresponds to your selected runtime.

2. Compressing Your Files (.zip)

The Dashboard accepts project uploads in .zip format. To ensure the file is generated correctly:

Select all files in your project's root folder (including squarecloud.app, your main file, and dependency files).
Right-click and select the option to compress/zip.
Warning: Compress the files, not the folder containing them. If you open the .zip file, you should see the code immediately, rather than a single root folder.
What NOT to include in the .zip: Avoid sending heavy, locally generated dependency folders such as node_modules (Node.js), venv (Python), or heavy hidden files like the .git folder. Square Cloud will automatically install the dependencies during deployment.

3. Uploading to the Dashboard

With your .zip file ready, it's time to upload the project to the platform.

Access the Square Cloud Dashboard and log in.
On the home screen, locate the "New Application" button or the upload area.
Click to select the file on your computer or simply drag and drop your .zip file into the indicated area.
Wait for the progress bar to complete. The time varies depending on your project size and internet connection.

4. Monitoring the Build and Logs

As soon as the upload is complete, Square Cloud will automatically start the build process for your environment.

You will be redirected to your application's management page.
Go to the "Logs" (or Terminal) tab.
Follow the messages on the screen. You will see the platform downloading your dependencies (e.g., running npm install or pip install) and then starting your main file.
If your code runs without errors, you will see the success message in the terminal, indicating that the application is Online.

Encountered an error?

The vast majority of errors during the first deployment are related to the absence of the squarecloud.app file, typos inside it, or the .zip being compressed incorrectly (zipping the folder instead of the files). Review the steps above or consult the Official Documentation for more details regarding your specific programming language.

Updated on: 05/19/2026

Was this article helpful?

Thank you!