Skip to content
LKCMS 文档

环境配置

安装 LKCMS 并配置开发环境

环境配置

参照 MkSaaS 文档 的安装方式,LKCMS 的安装框架同样简洁。

前置要求

系统要求

  • Node.js: >= 18.17.0
  • npm: >= 9.0.0 或 yarn >= 1.22.0
  • 数据库: PostgreSQL >= 14 或 MySQL >= 8.0
  • (可选) Docker >= 20.10
  • (可选) Redis >= 6.0

推荐技术栈了解

  • 基础:HTML, CSS, JavaScript
  • 进阶:React, TypeScript, Next.js
  • 数据库:SQL 基础知识

安装步骤

1. 克隆项目

git clone https://github.com/lkcms/lkcms.git
cd lkcms

2. 安装依赖

npm install
# 或
yarn install
# 或
pnpm install

3. 配置环境变量

cp .env.example .env

编辑 .env 文件,配置以下必需项:

# 数据库类型
LK_DATABASE_TYPE=postgres  # 或 mysql
 
# 数据库连接(PostgreSQL 示例)
DATABASE_URL=postgresql://user:password@localhost:5432/lkcms
 
# 应用基础 URL
NEXT_PUBLIC_BASE_URL=http://localhost:3000

4. 初始化数据库

# 生成迁移
npm run db:generate
 
# 执行迁移
npm run db:migrate
 
# 填充初始数据(可选)
npm run db:seed

5. 启动开发服务器

npm run dev

访问 http://localhost:3000 查看站点。

Docker 安装(推荐生产环境)

# 复制环境变量
cp .env.example .env
 
# 启动所有服务
docker-compose up -d

下一步

On this page