Hosting a Vue Application on Square Cloud

​

Introduction

• Before you begin, make sure you have Node.js and npm installed on your system. If you don’t have them yet, you can download them from the official Node.js website.
• Next, you will need to create an account on Square Cloud, which can be done through the sign up page. You can use your email 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 a Vue Project

To create a new Vue project, run the following command:

npm create vue@latest

In this command, npm create vue@latest is used to create a new Vue project with the latest version of Vue. The npm create command is a tool that comes with npm, the Node.js package manager. It is used to initialize a new or existing npm package.

vue@latest is a package available on the npm registry that sets up a new Vue project for you. It takes care of all the initial setup, such as creating the project directory, installing necessary dependencies, and configuring basic files.

@latest is a tag specifying that you want to use the latest version of the vue package. This ensures you’re always using the most updated version and, consequently, have access to the latest features.

​

Configuring Port 80

Port 80 is the default port for HTTP traffic. To host a Vite app on Square Cloud, configure the use of port 80. In Vite, you can set the --port 80 parameter in the startup script to ensure your app runs correctly on this port.

​

Creating the squarecloud config file

​

Configuring the START Field

In the Square Cloud configuration file, the START field is essential to customize the startup command. If you want to build and start your Vite app on Square Cloud, configure the START field as follows:

START=npm run build && npm run serve

This command will execute the “build” and “serve” scripts defined in your package.json:

{
  "name": "vue-project",
  "version": "0.0.0",
  "private": true,
  "type": "module",
  "scripts": {
    "dev": "vite",
    "build": "vite build",
    "serve": "vite preview --port 80"
  },
  "dependencies": {
    "vue": "^3.4.21"
  },
  "devDependencies": {
    "@vitejs/plugin-vue": "^5.0.4",
    "vite": "^5.2.8"
  }
}

​

Purchasing a Plan Before Uploading Your Project

Before you can upload your project to Square Cloud, it’s important to understand that you need to purchase a plan. The type of plan you choose will depend on the resources required by your application. You can view our plans here.

​

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

​

Troubleshooting

​

Additional Resources

For more information about Vue and its tools, visit the official Vue documentation. There, you’ll find detailed guides, tutorials, and API documentation to help you make the most of Vue.

If you continue to experience any issues, please don’t hesitate to contact our support team.