Skip to main content

​
Introduction

To develop and host on Square Cloud, it’s essential to follow a structured sequence of configurations and prerequisites. This technical guide will cover the entire process, from initial setup to production deployment.

​
Prerequisites

  • Square Cloud Account: Register through the signup page using your email.
  • Active Paid Plan: Ensures dedicated resources and optimized performance for your application. Check our available plans and choose the most suitable for your needs.
Wondering how much RAM and CPU your plan needs to host SolidJS Applications?
Don't worry, we're here to help. Our Standard plan offers 4GB of RAM and 4vCPU, which should be sufficient for most SolidJS Applications. However, if you are working on a larger project and seeking extra stability, we recommend considering our Pro plan. With additional resources, you can maintain stability even during demand spikes. To purchase, simply click here.

​
Creating the project

Before you begin, make sure you have Node.js and npm installed on your system. If you don’t have them, you can download them from the official Node.js website. To create a new SolidJS project, run the following command: 
npm init solid
This command will prompt you to select a template, set a name and other configurations for your new SolidJS project.

​
Understanding the Difference between JavaScript and TypeScript

When you choose JavaScript, Solid configures the project with default JavaScript settings. On the other hand, when you choose TypeScript, Solid configures the project with TypeScript settings, including the generation of a tsconfig.json file.

​
Building the project

Before uploading to production, generate the production artifacts using the build command: 
npm run build
This command will build your application and create a production-ready version. The output will depend on template or build tool you selected when creating the project.

​
Deploying

If you are using Vite as your build tool, see Vite tutorial for more details on serving the production build.
If you are using vinxi as your build tool, it comes with a built-in server to serve the production build. You can start the server by editing the start script in your package.json file to: 
"scripts": {
  "start": "vinxi start --port 80"
}
Then, you can set the following START command to start the server: 
npm run start
What port should I use for my server?
You should use port 80 for your server. Port 80 is the default port for HTTP traffic, which is handled by Square Cloud to route it to 443, HTTPS, for a secure connection.
Make sure to configure it before compressing and uploading your project.

​
Via dashboard

1

Access the Upload Page

Access the upload page and upload your project zip file.
2

Configure Your Environment

After uploading your zip, you will need to configure the name, main file or runtime environment and other settings for your project.
If you are uploading a web project, make sure to select "Web Publication" and set a subdomain to your project.
3

Deploy Your Project

Finally, click on the "Deploy" button to host your project on Square Cloud.
After deployment, you can monitor your project's status and logs from the dashboard.

​
Via CLI

To use this method, you need to create a config file named squarecloud.app in the root directory of your project. This file will contain the necessary configuration for your project.

Learn more about: how to create 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 your environment.
1

Install the CLI

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:
npm install -g @squarecloud/cli
If you already have it, we recommend updating it. To do this, run the following command in your terminal:
squarecloud update
2

Authenticate

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:
squarecloud auth login
3

Upload Your Project

Finally, to deploy your application to Square Cloud using the CLI, you need to run the following command:
squarecloud upload
Or if you created the zip manually, you can use:
squarecloud upload --file <path/to/zip>

​
Additional Resources

For more information about Solid and its tools, visit the official Solid documentation. There you will find detailed guides, tutorials, and API documentation to help you get the most out of Solid.

​
Troubleshooting

​
Custom Domain

To use a custom domain (e.g., mysite.com) instead of the default URL mysite.squareweb.app, you need the Standard plan or higher. The subdomain is defined by the SUBDOMAIN field in the configuration file. See: How to set up your custom domain.

​
Minimum RAM Requirements

Minimum: 512MB RAM for simple websites/APIs. For sites with frameworks (Next.JS, React, Vue, Angular, etc.), we always recommend at least 1GB RAM. For larger applications, use more RAM to avoid LACK_OF_RAM error and ensure performance.

​
Could not find this site.

Check if the subdomain/domain matches what's configured in the SUBDOMAIN field or in the custom domain settings. If you just uploaded the site, wait up to 60 seconds for Square to enable first access.

​
Site took too long to respond...

Check if you correctly configured port 80 and host 0.0.0.0 in the application. We recommend using Square's forced environment variables: PORT and HOST from the .env file.

​
Contact us

If you continue facing technical difficulties, our specialized support team is available to assist you. Contact us and we'll be happy to help you resolve any issue.