Skip to content

Basic Project Settings

Change Project Name

To change the project name, you need to update two files: index.html and package.json

  • Update index.html

In the root directory's index.html file, find the <title> tag and replace its content with the new project name.

index.html
html
<head>
  <meta charset="UTF-8" />
  <link rel="icon" type="image/svg+xml" href="/logo.svg" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>vue3-naiveui-admin</title> 
  <title>Custom Content</title> 
</head>
  • Update package.json

In the package.json file, find the "name" field and replace its value with the new project name.

json
{
  "name": "vue3-naiveui-admin", 
  "version": "1.0.0",
  "description": "",
  "type": "module"
}
  • Dynamic Title Configuration

If you do not want the project to have dynamic page titles, comment out the dynamic title configuration in src/router/modules/guard.ts.

ts
router.afterEach((to) => {
  // Remove the following setting
  document.title = to.meta?.title ? to.meta?.title : pkg.name; 
});

Environment Variables

Development Environment

Development environment variables are variables that are only switched during development, such as setting the request prefix. Define these variables in the .env.development file.

Base path

VITE_BASE_URL

  • Type: string
  • Default: /

If your project is deployed under a subpath, set VITE_BASE_URL to the subpath, such as /admin.

Dev server port

VITE_APP_PORT

  • Type: number
  • Default: 5173

By default, Vite runs the dev server on port 5173. Set VITE_APP_PORT to your project port, such as 8080.

API request prefix

VITE_APP_BASE_API

  • Type: string
  • Default: /dev-api

Configure the API request prefix, such as /dev-api.

API request timeout

VITE_APP_TIMEOUT

  • Type: number
  • Default: 6000

Configure the API request timeout, such as 6000.

Backend API URL

VITE_APP_API_URL

  • Type: string
  • Default: http://localhost:8989

Proxy forwarding real API address.

WebSocket endpoint

VITE_APP_WS_ENDPOINT

  • Type: string
  • Default: ws://localhost:8989/ws

Configure the WebSocket address.

Default language (in progress)

VITE_DEFAULT_LANG

  • Type: zhCN enUS zhTW
  • Default: zhCN

Configure the default language, default is Simplified Chinese.

Storage prefix

VITE_STORAGE_PREFIX

  • Type: string
  • Default: store-

Set the global storage prefix, default is store-. When using src\utils\storage.ts, the data in localStorage and sessionStorage will be prefixed with store-, for example, store-user.

Production Environment

Configure production environment variables, such as those defined in the .env.production file. The configuration is the same as the Development Environment.

Contributors

Changelog

Released under the MIT License