getting-started-with-elixir.mdx

title	Getting Started on Square Cloud with Elixir
sidebarTitle	Elixir
icon	flask
description	Learn how to get started on Square Cloud with Elixir

🚀 Introduction

• Before you begin, make sure you have Elixir on your system. If you don't have them yet, you can download them from the official Elixir 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

<Card title="Learn about: how to make the configuration file for Square Cloud." icon="link" href="https://docs.squarecloud.app/getting-started/config-file"

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.ex (Example of main file).
• mix.exs (Dependency file).
• squarecloud.app (file that contains the Square Cloud configuration).

▶️ Start Application

• If the START field is not defined in the configuration file, Square Cloud will run mix run --no-halt to start the project. If the START field is defined in the configuration file, the value in the START field will be executed directly. For more information on configuration file parameters, visit configuration parameters.

• Square Cloud performs a local installation of the hex and rebar tools and obtains project dependencies with mix deps.get.

🖥️ 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.

Access the [Square Cloud Dashboard](https://squarecloud.app/dashboard/upload) and upload your project files.

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: ```bash squarecloud update ``` ```bash curl -fsSL https://cli.squarecloud.app/install | bash ``` Now, to authenticate and use other CLI commands, you will find your authorization key [here](https://squarecloud.app/account) by clicking on "Request API Key". After obtaining your authorization key, run the following command: ```bash squarecloud login ``` 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: ```bash squarecloud upload zip ```

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