This chapter introduces how to set up the Yao development and debugging environment locally. For production use, please refer to the deployment document.

Latest Version download and installation:

https://github.com/YaoApp/xgen-dev-app/blob/main/README.md

Go to the project directory and use the run command to run streams, scripts, plugins, and built-in handlers.

yao run <process> [args...]

cd /data/customer
yao run xiang.main.Inspect

Parameters Table:

yao start

Enter the project directory and use the start command to start the service. The default service port is 5099, which can be specified by declaring an environment variable. [environment variable](#environment variable)

cd /data/customer
yao start

Parameters Table:

You can configure database connections by declaring environment variables, specifying service ports, and configuring database connections. For example:

export YAO_ENV="production" # development | production run mode
export YAO_ROOT="/data/app" # Application directory
export YAO_HOST="127.0.0.1" # Service HOST
export YAO_PORT="5099" # listen port
export YAO_LOG="/data/app/logs/application.log" # log file location
export YAO_LOG_MODE="TEXT" # log mode TEXT | JSON
export YAO_JWT_SECRET="bLp@bi!oqo-2U+hoTRUG"
export YAO_DB_DRIVER="mysql" # database type mysql | sqlite3
export YAO_DB_PRIMARY="root:123456@tcp(db-server:3308)/xiang?charset=utf8mb4&parseTime=True&loc=Local" # Main library connection
export YAO_DB_SECONDARY="root:123456@tcp(db-server:3308)/xiang?charset=utf8mb4&parseTime=True&loc=Local" # Connect from the library
export YAO_DB_AESKEY="ZLX=T&f6refeCh-ro*r@" # Encrypted storage field key MySQL Only

You can add .env to the root directory of the project directory, and the environment variables declared in .env will be used first when the service starts; or append the above command to the ~/.bashrc file (macos ~/.bash_profile )

/data/customer/.env file contents

YAO_ENV="production" # development | production run mode
YAO_ROOT="/data/app" # Application directory
YAO_HOST="127.0.0.1" # Service HOST
YAO_PORT="5099" # Listening port
YAO_LOG="/data/app/logs/application.log" # log file location
YAO_LOG_MODE="TEXT" # log mode TEXT | JSON
YAO_JWT_SECRET="bLp@bi!oqo-2U+hoTRUG"
YAO_DB_DRIVER="mysql" # database type mysql | sqlite3
YAO_DB_PRIMARY="root:123456@tcp(db-server:3308)/xiang?charset=utf8mb4&parseTime=True&loc=Local" # Main library connection
YAO_DB_SECONDARY="root:123456@tcp(db-server:3308)/xiang?charset=utf8mb4&parseTime=True&loc=Local" # Connect from the library
YAO_DB_AESKEY="ZLX=T&f6refeCh-ro*r@" # Encrypted storage field key MySQL Only

Next, it is recommended to study the following chapters: