首页
/ Magic-JS 项目教程

Magic-JS 项目教程

2024-09-16 10:03:14作者:凌朦慧Richard

1. 项目目录结构及介绍

Magic-JS 项目的目录结构如下:

magic-js/
├── packages/
│   ├── magic-sdk/
│   ├── @magic-sdk/react-native-bare/
│   ├── @magic-sdk/react-native-expo/
│   ├── @magic-sdk/types/
│   ├── @magic-sdk/pnp/
│   ├── @magic-sdk/provider/
│   ├── @magic-sdk/commons/
│   └── @magic-sdk/types/
├── scripts/
├── jest.config.ts
├── lerna.json
├── package.json
├── tsconfig.settings.json
├── tsconfig.settings.test.json
├── yarn.lock
├── BUILD_SYSTEM.md
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
└── README.md

目录结构介绍

  • packages/: 包含 Magic-JS 的核心包和扩展包。

    • magic-sdk/: 用于 Web 浏览器的 Magic SDK 入口。
    • @magic-sdk/react-native-bare/: 用于 Bare React Native 的 Magic SDK 入口。
    • @magic-sdk/react-native-expo/: 用于 Expo React Native 的 Magic SDK 入口。
    • @magic-sdk/types/: 核心类型定义,供其他包使用。
    • @magic-sdk/pnp/: 一个轻量级的连接器,用于将 Magic JS 认证与漂亮的登录表单集成。
    • @magic-sdk/provider/: 核心业务逻辑,供其他包使用。
    • @magic-sdk/commons/: 暴露 @magic-sdk/provider@magic-sdk/types 的公共 API。
  • scripts/: 包含项目的脚本文件。

  • jest.config.ts: Jest 测试配置文件。

  • lerna.json: Lerna 配置文件,用于管理多包项目。

  • package.json: 项目的依赖和脚本配置文件。

  • tsconfig.settings.json: TypeScript 配置文件。

  • tsconfig.settings.test.json: 用于测试的 TypeScript 配置文件。

  • yarn.lock: Yarn 锁定文件,确保依赖版本一致。

  • BUILD_SYSTEM.md: 构建系统的说明文档。

  • CHANGELOG.md: 项目变更日志。

  • CONTRIBUTING.md: 贡献指南。

  • LICENSE: 项目许可证。

  • README.md: 项目介绍和使用说明。

2. 项目的启动文件介绍

Magic-JS 项目的启动文件主要集中在 packages/ 目录下,每个包都有自己的入口文件。以下是主要的启动文件介绍:

packages/magic-sdk/src/index.ts

这是 Web 浏览器的 Magic SDK 入口文件。它导出了主要的 API 和功能,供开发者使用。

packages/@magic-sdk/react-native-bare/src/index.ts

这是用于 Bare React Native 的 Magic SDK 入口文件。它提供了与 React Native 环境兼容的 API。

packages/@magic-sdk/react-native-expo/src/index.ts

这是用于 Expo React Native 的 Magic SDK 入口文件。它提供了与 Expo 环境兼容的 API。

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。以下是一些关键配置项:

{
  "name": "magic-js",
  "version": "1.0.0",
  "scripts": {
    "test": "yarn test",
    "build": "yarn build"
  },
  "dependencies": {
    "magic-sdk": "^1.0.0",
    "@magic-sdk/react-native-bare": "^1.0.0",
    "@magic-sdk/react-native-expo": "^1.0.0"
  },
  "devDependencies": {
    "typescript": "^4.0.0",
    "jest": "^26.0.0"
  }
}

tsconfig.settings.json

TypeScript 配置文件,定义了 TypeScript 编译器的选项。

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  }
}

jest.config.ts

Jest 测试配置文件,定义了测试框架的选项。

module.exports = {
  preset: 'ts-jest',
  testEnvironment: 'node',
  testMatch: ['**/?(*.)+(spec|test).[jt]s?(x)'],
  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
};

通过以上配置文件,开发者可以轻松地启动项目、运行测试和构建项目。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
154
1.98 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
405
387
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
941
555
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Python
75
70
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
992
395
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
509
44
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.32 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
194
279