跳到主要内容

安装指南

本指南将详细介绍如何在不同环境中安装和配置我们的产品。

系统要求​

确保您的系统满足以下最低要求：

要求最低版本推荐版本
Node.jsv16.0.0v18.0.0 或更高
npmv7.0.0v8.0.0 或更高
内存4GB8GB 或更高
磁盘空间1GB 可用空间2GB 或更多

安装方式​

我们提供多种安装方式，您可以选择最适合您的方式：

1. 使用 npm 安装​

# 安装最新稳定版
npm install our-product

# 安装特定版本
npm install our-product@1.2.3

# 安装最新的测试版
npm install our-product@beta

2. 使用 yarn 安装​

# 安装最新稳定版
yarn add our-product

# 安装特定版本
yarn add our-product@1.2.3

# 安装最新的测试版
yarn add our-product@beta

3. 使用 CDN 引入​

<!-- 引入最新版本 -->
<script src="https://cdn.example.com/our-product/latest/index.min.js"></script>

<!-- 引入特定版本 -->
<script src="https://cdn.example.com/our-product/1.2.3/index.min.js"></script>

4. 从源码构建​

如果您需要从源码构建，可以按照以下步骤操作：

# 克隆代码库
git clone https://github.com/your-org/our-product.git

# 进入项目目录
cd our-product

# 安装依赖
npm install

# 构建项目
npm run build

验证安装​

安装完成后，您可以通过以下代码验证安装是否成功：

import { version } from 'our-product';

console.log(`产品版本: ${version}`);

您应该能够看到当前安装的产品版本号。

配置环境变量​

某些功能可能需要特定的环境变量，您可以在项目根目录创建 .env 文件：

API_KEY=your_api_key_here
ENVIRONMENT=development
DEBUG=true

常见问题​

安装过程中遇到权限错误​

如果您在安装过程中遇到权限错误，可以尝试以下解决方案：

# 在 Linux/Mac 上使用 sudo
sudo npm install our-product

# 或者修复 npm 权限问题
npm config set prefix ~/.npm

版本冲突问题​

如果遇到依赖冲突问题，可以尝试：

# 清除 npm 缓存
npm cache clean --force

# 使用 force 选项安装
npm install our-product --force

下一步​

  • 快速开始 - 了解如何开始使用产品的基本功能
  • 配置指南 - 学习如何配置产品以适应您的需求
  • 升级指南 - 从旧版本升级到最新版本的注意事项