iztro 开源项目使用教程

iztro 开源项目使用教程

iztro⭐A lightweight Open-Source javascript library of getting The Purple Star Astrology(Zi Wei Dou Shu) astrolabe information. 支持多语言轻量级获取紫微斗数排盘信息的javascript开源库。项目地址:https://gitcode.com/gh_mirrors/iz/iztro

1. 项目的目录结构及介绍

iztro 项目的目录结构如下：

iztro/
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── config/
│   │   ├── defaultConfig.js
│   ├── utils/
│   ├── modules/
│   ├── plugins/
├── docs/
│   ├── README.md
│   ├── installation.md
│   ├── usage.md
│   ├── configuration.md
├── tests/

目录结构介绍

• README.md: 项目的主文档，包含项目的基本信息和使用说明。
• package.json: 项目的配置文件，包含依赖、脚本等信息。
• src/: 源代码目录。
  • index.js: 项目的入口文件。
  • config/: 配置文件目录，包含默认配置文件 defaultConfig.js。
  • utils/: 工具函数目录。
  • modules/: 模块目录。
  • plugins/: 插件目录。
• docs/: 文档目录，包含详细的使用和配置文档。
• tests/: 测试目录。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js，它是整个项目的入口点。以下是 index.js 的基本内容：

import { astro } from 'iztro';

// 通过阳历日期获取星盘数据
const astrolabe = astro.bySolar('2000-8-16', 2, 'male', true, 'en-US');

// 通过阴历日期获取星盘数据
const astrolabeByLunar = astro.byLunar('2000-7-17', 2, 'male', true, 'en-US');

console.log(astrolabe);
console.log(astrolabeByLunar);

启动文件介绍

• 导入模块: 使用 import 语句导入 iztro 库中的 astro 模块。
• 获取星盘数据: 通过 bySolar 和 byLunar 方法获取星盘数据。
• 输出结果: 将获取的星盘数据输出到控制台。

3. 项目的配置文件介绍

项目的配置文件位于 src/config/defaultConfig.js，它包含了项目的默认配置。以下是 defaultConfig.js 的基本内容：

module.exports = {
  language: 'en-US',
  brightness: {
    normal: 1,
    dim: 0.5,
    bright: 1.5
  },
  mutagen: {
   忌: '忌',
   科: '科',
   权: '权',
   禄: '禄'
  }
};

配置文件介绍

• language: 默认语言设置。
• brightness: 星耀亮度的配置，包含 normal、dim 和 bright 三个级别。
• mutagen: 四化配置，包含 忌、科、权 和 禄 四个属性。

通过修改 defaultConfig.js 文件，可以自定义项目的配置，以满足不同流派和功能扩展的需求。

iztro⭐A lightweight Open-Source javascript library of getting The Purple Star Astrology(Zi Wei Dou Shu) astrolabe information. 支持多语言轻量级获取紫微斗数排盘信息的javascript开源库。项目地址:https://gitcode.com/gh_mirrors/iz/iztro