Lexicon 开源项目安装与使用教程

Lexicon 开源项目安装与使用教程

lexicon Built with Expo, React Native, and GraphQL, Lexicon is a pre-built mobile discussions app that you can customize for your users. 项目地址: https://gitcode.com/gh_mirrors/lex/lexicon

1. 项目目录结构及介绍

Lexicon 是一个基于 Expo、React Native 和 GraphQL 构建的可定制移动讨论应用模板。以下是项目的目录结构及其介绍：

lexicon/
├── api/
│   ├── src/
│   │   ├── schema/
│   │   ├── resolvers/
│   │   └── ...
│   ├── .env
│   ├── package.json
│   └── ...
├── frontend/
│   ├── src/
│   │   ├── components/
│   │   ├── constants/
│   │   ├── screens/
│   │   └── ...
│   ├── Config.ts
│   ├── package.json
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── package.json
└── ...

目录结构说明

• api/: 包含 GraphQL API 的源代码和相关配置文件。

  • src/: 包含 GraphQL 的 schema 和 resolvers。
  • .env: 环境变量配置文件。
  • package.json: API 项目的依赖管理文件。

• frontend/: 包含 React Native 前端应用的源代码和相关配置文件。

  • src/: 包含应用的组件、常量、屏幕等。
  • Config.ts: 前端应用的配置文件。
  • package.json: 前端项目的依赖管理文件。

• .gitignore: Git 忽略文件列表。

• LICENSE: 项目许可证文件。

• README.md: 项目说明文档。

• package.json: 根目录的依赖管理文件。

2. 项目启动文件介绍

2.1 API 服务启动

在 api/ 目录下，启动 GraphQL API 服务的命令如下：

$ yarn --cwd api start

启动后，API 服务将运行在默认的 http://0.0.0.0:8999/graphql 地址。

2.2 前端应用启动

在 frontend/ 目录下，启动 React Native 应用的命令如下：

$ cd frontend
$ yarn start

启动后，Expo 会生成一个 QR 码，可以通过 Expo Go 应用在移动设备上扫描该 QR 码来运行应用。

3. 项目配置文件介绍

3.1 API 配置文件

在 api/ 目录下，主要的配置文件是 .env，用于设置环境变量。例如：

PROSE_DISCOURSE_HOST=https://users.rust-lang.org

该配置文件指定了 GraphQL API 连接的 Discourse 实例的 URL。

3.2 前端配置文件

在 frontend/ 目录下，主要的配置文件是 Config.ts，用于配置前端应用的连接信息。例如：

const config = {
  localDevelopment: {
    proseUrl: 'http://localhost'
  }
};

该配置文件指定了前端应用在本地开发环境中连接的 GraphQL API 的 URL。

通过以上步骤，您可以成功启动 Lexicon 项目并进行开发和测试。

lexicon Built with Expo, React Native, and GraphQL, Lexicon is a pre-built mobile discussions app that you can customize for your users. 项目地址: https://gitcode.com/gh_mirrors/lex/lexicon