Skip to content
文档
生日彩蛋项目
快速开始

快速开始

欢迎你来到wuhu-home-Caidan开源项目的第一章，在本系列文档中，我会把安装、修改、部署讲的极其清楚。阅读完这一章你会完成项目所需的⌈基础编译⌋操作

安装基础环境

如果您已经安装过了基础环境，您可以跳过本部分内容

1. 访问Node.js官网并下载适合你的操作系统版本
  1. 打开浏览器，输入地址栏 https://nodejs.org/ 并回车访问Node.js官方网站。
  2. 在首页找到“LTS”或“Current”版本下载链接，推荐选择LTS版。
  3. 根据你的计算机操作系统选择相应的安装包：
    • Windows 用户：通常选择.msi安装程序。
    • macOS 用户：选择.pkg文件。
    • Linux 用户：通过各自的包管理器（如apt、yum等）或者下载tar.gz压缩包后手动编译安装。
2. 安装Node.js

  • Windows:

    1. 下载完成后，双击打开.msi文件开始安装过程。
    2. 在安装向导中确保“Add to PATH”选项被勾选，以便全局使用Node.js命令行工具。
    3. 点击“Next”及“I Agree”接受许可协议，然后按照提示完成安装。

  • macOS:

    1. 双击下载的.pkg文件启动安装程序。
    2. 按照安装引导进行，同意许可协议，并跟随向导指示进行安装。

  • Linux (通过解压tar.gz包手动安装)：

    1. 解压下载的文件： 
      tar -xzvf node-v<version>-<platform>-<arch>.tar.gz
    2. 进入解压后的目录并将内容复制到 /usr/local/ 目录下： bash cd node-v<version>-<platform>-<arch> sudo cp -R * /usr/local/
Linux详细安装步骤（补档）
  1. 首先，将下载压缩包移动到一个合适的安装目录，如 /usr/local/。这里以 /usr/local/ 为例：
sudo mkdir -p /usr/local/nodejs
sudo mv node-v<version>-linux-x64.tar.gz /usr/local/nodejs/
  1. 进入该目录并解压文件：
cd /usr/local/nodejs/
sudo tar -xzvf node-v<version>-linux-x64.tar.gz
  1. 创建软链接：
sudo ln -s /usr/local/nodejs/node-v<version>-linux-x64/bin/node /usr/local/bin/node
sudo ln -s /usr/local/nodejs/node-v<version>-linux-x64/bin/npm /usr/local/bin/npm
  1. 更新环境变量
echo 'export PATH=$PATH:/usr/local/nodejs/node-v<version>-linux-x64/bin' >> ~/.bashrc
source ~/.bashrc

注：你应该自己替换 <version> 为实际下载的Node.js版本号。确保对上述路径有正确的权限操作。

最后 记得在命令行中分别输入以下命令看看Node.js和npm是否已成功安装并可用：

node -v npm -v

若在Windows、Linux环境下遇到PATH问题，可以试试重启命令行窗口或电脑以更新环境变量。

3.使用npm全局安装pnpm
  1. 打开命令行工具（在Windows下按 Win + R 键，输入 cmd 并回车；在Mac下，打开“终端”应用）。
  2. 输入以下命令来全局安装pnpm：
npm install -g pnpm

如果需要管理员权限，在Unix/Linux/macOS下加上sudo：

sudo npm install -g pnpm
4. 验证pnpm安装是否成功

安装完毕后，在命令行中输入以下命令检查pnpm是否已经正确安装：

pnpm --version
  • 若在全局安装过程中遇到权限错误，确保以管理员身份运行命令行。
  • 若下载速度慢，请参考：
针对npm下载速度优化
  1. 在命令行中执行以下命令设置阿里npm镜像作为默认源（替换 https://registry.npmmirror.com 或者其他国内镜像源地址亦可）： 
    npm config set registry https://registry.npmmirror.com
  2. 验证配置是否成功，运行： 
    npm config get registry
    假如输出的是你刚才设置的国内镜像源URL，则表示已经更改成功了

开始部署

安装完毕基础环境后，在你的电脑里面新建一个文件夹testbir（文件夹的名字你可以自己定，但是到了后面你要注意不要搞错。按理来说新建在哪里都可以，但是我不建议放在桌面）。 演示图片 选择“在终端打开”（如果您是其他系统） 在终端打开-图片

当然你也可以使用Win+R键，在运行的窗口中输入cmd打开CMD终端。然后使用cd + 你的路径

cd F:\Project\testbir (路径需要替换成你自己的哟！)

然后跟着我一起把项目克隆到本地：

git clone https://github.com/shuakami/wuhu-home-Caidan.git

windowscmd克隆图片

Github网络克隆失败帮助

省流版本

把git clone https://github.com/shuakami/wuhu-home-Caidan.git换成git clone https://kkgithub.com/shuakami/wuhu-home-Caidan.git

1. 全局加速

你可以在访问GitHub时直接在域名前加上镜像站地址来加速访问和查看项目代码：

  • 使用KK GitHub镜像：
    • 将 https://github.com/ 替换为 https://kkgithub.com/
    • git clone https://kkgithub.com/shuakami/wuhu-home-Caidan.git

2. 文件加速

若仅需下载项目中的特定文件或子模块，可以利用以下文件加速服务：

如何使用镜像站点克隆项目

以KK GitHub镜像为例，使用镜像克隆项目的命令如下：

git clone https://kkgithub.com/shuakami/wuhu-home-Caidan.git

对于镜像站点，ByteFreeze无法保证其可用度。具体信息可用访问对应网站阅读

然后我们跳转到项目源代码目录，安装依赖

cd wuhu-home-Caidan
pnpm install

windowscmd运行cd和pnpminstall图片

如果您是其他系统

假如您是Linux

  1. 打开终端（可以通过快捷键 Ctrl + Alt + T 或者在文件管理器中右键选择“在终端打开”）。

  2. 创建一个新的文件夹——然后打开它：

    mkdir ~/Projects/testbir && cd $_

  3. 克隆项目到本地（可能要在前面加sudo）：

    git clone https://github.com/shuakami/wuhu-home-Caidan.git

  4. 跳转到项目源代码目录并安装依赖：

    cd wuhu-home-Caidan
pnpm install

    小提示QAQ：在Linux系统下，使用$_可以快速引用上一条命令的最后一个参数，即新建目录的路径。 如果你的默认shell不是bash，你可能需要调整一下...命令

假如您是MacOS

  1. 创建一个文件夹： 打开“Finder”，在你希望存放项目的文件夹位置新建一个文件夹，例如在"Documents/Projects/"下新建一个名为"testbir"的文件夹。

  2. 打开终端并切换到项目目录：

    • 打开“应用程序” -> “实用工具” -> “终端”。
    • 在终端中使用cd命令切换到你刚才创建的项目目录。我这里演示项目位于~/Documents/Projects/testbir： 
      cd ~/Documents/Projects/testbir

  3. 克隆项目到本地： 使用git从GitHub上克隆项目：

    git clone https://github.com/shuakami/wuhu-home-Caidan.git

  4. 进入项目源代码目录并安装依赖： 克隆完成后，切换到项目源代码目录，并使用pnpm安装项目依赖：

    cd wuhu-home-Caidan
pnpm install

注意：

  • 需要你的macOS正确安装了Git和pnpm，并把他们添加到了系统的PATH环境变量中。
  • 上述路径 ~/Documents/Projects/testbir 是🌰，请根据实际自己调整一下。
介绍基础文件树介绍