Profile Introduction

Profile Introduction

This document describes the backend and frontend configuration files of the Lemon open source project in detail to help you configure them according to your needs.

Backend Configuration File

The backend configuration file is located at the root of the project.envFile. You can refer.env.exampleFile to learn about the available configuration items and their examples.

Configuration Item Description

  • STORAGE_PATH
    • Description: Defines where SQLite database files are stored.
    • Default:data/database.sqlite
    • Example:

STORAGE_PATH=data/database.sqlite\

*

  • Note: If not configured, the system will use the defaultdata/database.sqliteAs the storage path for the database file.
    • WORKSPACE_DIR
  • Description: Defines the mapping path of the workspace on the local host.
  • Example:

WORKSPACE_DIR=workspace\

  • RUNTIME_TYPE
    • Description: Defines how to start the backend service.
    • Default:docker(Sandbox Environment required)
    • Optional values:
      • docker: The default value, which means running in the Docker sandbox environment.
      • local: For developers to use when debugging locally.
    • Example:

RUNTIME_TYPE=docker\

Front End Configuration File

Front-end configuration files are located infrontend/.envUnder the document. You can referfrontend/.env.exampleFile to learn about the available configuration items and their examples.

Configuration Item Description

  • VITE_SERVICE_URL
    • Description: Defines the start address and port of the backend service.
    • Default:http://127.0.0.1:3000
    • Example:

VITE_SERVICE_URL=http://127.0.0.1:3000\

*

  • Note: Modify the endpoint and port of the backend service.
    • VITE_PORT
  • Description: Defines the port number of the front-end application.
  • Default:5005
  • Example:

VITE_PORT=5005\

*

Hopefully, this introduction to configuration files will help you better understand and configure your Lemon project.

results matching ""

    No results matching ""