Skip to content

Commit

Permalink
docs: section in Chinese for preparing to debug
Browse files Browse the repository at this point in the history
  • Loading branch information
ourai committed Dec 10, 2024
1 parent d438cc6 commit 7ff5b3d
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 10 deletions.
12 changes: 6 additions & 6 deletions .env.example
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
NEXT_PUBLIC_API_BASE_URL=https://test-api.openbuild.xyz/
NEXT_PUBLIC_APP_URL=http://localhost:3000

NEXT_PUBLIC_GA_ID=
NEXT_PUBLIC_GA_KEY=

NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=

NEXT_PUBLIC_APP_URL=http://localhost:3000
NEXT_PUBLIC_API_BASE_URL=https://test-api.openbuild.xyz/

NEXT_PUBLIC_GITHUB_ID=
NEXT_PUBLIC_GOOGLE_ID=
NEXT_PUBLIC_ASPECTA_ID=

NEXT_PUBLIC_GA_ID=
NEXT_PUBLIC_GA_KEY=
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

## Introduction

This project is a part of [OpenBuild Ecosystem](https://openbuildxyz.github.io/eco/).
This project is a part of [OpenBuild Ecosystem](https://openbuildxyz.github.io/eco/) and hosts the front-end codebase of [OpenBuild.xyz](https://openbuild.xyz).

## Contributing

Expand Down
31 changes: 28 additions & 3 deletions manual/getting-started/zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,37 @@

很高兴你能出现在这里!想必一定是对为本项目贡献聪明才智或从项目代码中学到必要能力而感兴趣,对吧?

在开始大展身手之前,为确保能顺利地参与共建及异步协作,请按顺序通读下列所有文档,已看过并熟悉了解的可跳过:
在开始大展身手之前,为保证能顺利地参与共建及异步协作,请按顺序通读下列所有内容,已看过并熟悉了解的可跳过:

- 社区行为规范(待写)
- 本文档
- [行为规范](#行为规范)
- [环境准备](#环境准备)
- [技术栈](#技术栈)
- [开发规范](../spec/zh.md)

来让我们开始吧!

## 行为规范

沿用 OpenBuild 生态行为规范(待写)。

## 环境准备

确保本地 Node.js 版本号符合 [`package.json`](../../package.json)`engines` 字段所指定的,在根目录用包管理器安装依赖,建议使用 [pnpm](https://pnpm.io)

在根目录执行 `cp .env.example .env``cp .env.example .env.local` 以使运行应用所需环境变量能够正常注入:

| 变量名 | 作用 | 是否必需 |
| --- | --- | --- |
| `NEXT_PUBLIC_API_BASE_URL` | ||
| `NEXT_PUBLIC_APP_URL` | ||
| `NEXTAUTH_URL` | ||
| `NEXTAUTH_SECRET` | ||
| `NEXT_PUBLIC_GITHUB_ID` | | 用 GitHub 账号授权时 |
| `NEXT_PUBLIC_GOOGLE_ID` | | 用 Google 账号授权时 |
| `NEXT_PUBLIC_ASPECTA_ID` | | 展示 [Aspecta](https://aspecta.id) 的数据时 |
| `NEXT_PUBLIC_GA_ID` | | 做流量统计时 |
| `NEXT_PUBLIC_GA_KEY` | | - |

根据需要正确设置相应环境变量后,执行 npm scripts 中的 `start` 命令(如 `pnpm start`),即可在本地启动应用开始调试啦!

## 技术栈

0 comments on commit 7ff5b3d

Please sign in to comment.