Skip to main content

Comprehensive Guide to Setting Up a Nuxt Project Using a Compressed File

This guide will walk you through the process of setting up a project using a compressed file. Please follow the steps below carefully.

danger

Make sure that the package.json file is present in your project.

Compressing the Project​

To compress files on Linux operating systems, you can use the following command:

zip -r project.zip project_folder
caution

Please ensure that your compressed file format is strictly zip, and avoid using any other compression formats (such as rar, gz, 7z) for uploading to your cloud.

1. Initial Settings​

Initial Nuxt Settings

Application Name​

First, choose a suitable name for your application. This name will be used as an identifier in your project domain.

caution
  • Use lowercase letters and only use - as a separator between words.
  • You cannot change the application name after the app is created.

Node Version​

Select the Node version to be used in your project. You can choose from the available list or enter it manually. Please ensure that the Node version you are using is available in the Docker repository (dockerhub) or other related Docker repositories.

After completing this step, select the "Next" option.

2. Advanced Settings (Optional)​

Advanced Nuxt Settings

In this section, you can apply more detailed settings for your project:

Build​

Sample package.json file:

{
  "name": "my-nuxt-app",
  "version": "1.0.0",
  "private": true,
  "scripts": {
    "dev": "nuxt",
    "build": "nuxt build",
    "start": "nuxt start",
    "generate": "nuxt generate",
    "lint": "eslint --ext .js,.vue --ignore-path .gitignore ."
  },
  "dependencies": {
    "core-js": "^3.25.5",
    "nuxt": "^3.0.0"
  },
  "devDependencies": {
    "@nuxtjs/eslint-config": "^6.0.0",
    "eslint": "^8.33.0",
    "eslint-plugin-nuxt": "^4.0.0"
  },
  "eslintConfig": {
    "extends": ["@nuxtjs"]
  },
  "browserslist": ["> 1%", "last 2 versions", "not dead"]
}

Build Command​

  • Specific command(s) for building the project
  • Default: npm run build
  • To use multiple commands, use ; as a separator (e.g., npm run build;npm run generate)

Run Command​

  • Command to run the project
  • Default: node .output/server/index.mjs

Output Dir​

  • Location of the built files
  • For Nuxt.js, it is better not to specify an address.

Port​

Specify the port number on which your application will run. The default port is 3000, but you can change it.

tip

  • After the initial setup, it is possible to change the port.

  • To specify the port, make sure to use the address 0.0.0.0.

Resource Scheduling​

Disk​

Environment Variables​

3. Select Plan​

Select Nuxt Plan

In this step, select your desired plan. You can choose from the available list or set it manually.

Replicas​

Specify the number of replicas (running instances) of your application. This number affects the performance and availability of your application.

Importance of the Number of Replicas​

  • Scalability: Increased processing power with more replicas
  • High Availability: Maintaining performance in case one instance fails
  • Load Distribution: Distributing the load among multiple instances

After selecting your desired plan, choose the Create App option.

4. Upload File​

Upload Nuxt File

After creating your Nuxt app, upload your compressed project file by clicking the "Upload File" button, and wait for the project to build.

5. Project Management​

Nuxt Project Management

Once the project is built, you can manage your project from the "Project Management" section. In this section, you will have access to project management features:

  • Check project status

  • Manage connections and resources

  • Manage port

    info

    The port you defined in your project must also be defined in this section.

  • Rename Dockerfile (if needed)

    tip

    If your project requires very specific settings, you can create your own custom Dockerfile. For more information, refer to this link.

  • Change Build Command

    Nuxt Project Management

  • Change Run Command

    Nuxt Project Management

  • Specify Output Folder Location

    Nuxt Project Management

tip

If you want to use multiple commands for building the project, use ; as a separator (e.g., npm run build;npm run start)

With these features, you can effectively manage and maintain your project.