PIGEONPOSSE API

运行PigeonPosse API。

Rest API从GitHub存储库获取数据。

• 所需 @pigeonposse / web - 2026

先决条件

• GitHub令牌 阅读更多

安装

npm i @pigeonposse/api-2026
# or
pnpm i @pigeonposse/api-2026

CLI使用

GH_TOKEN="your-github-token" GH_USER="your-github-user" npx @pigeonposse/api-2026
# or
GH_TOKEN="your-github-token" GH_USER="your-github-user" pnpx @pigeonposse/api-2026

或者安装

npm i @pigeonposse/api-2026
GH_TOKEN="your-github-token" npm exec pigeonposse-api-2026
# or
pnpm i @pigeonposse/api-2026
GH_TOKEN="your-github-token" GH_USER="your-github-user" pnpm exec pigeonposse-api-2026

图书馆的使用

标准的服务器

import { createServer } from '@pigeonposse/api-2026' // OR: import { createServer } from '@pigeonposse/api-2026/server'
createServer( {
 DEBUG: 'false',
 GH_TOKEN: "your-github-token",
 GH_USER: 'angelespejo',
 GH_BRANCH: 'main',
 GH_USER_TYPE: 'user',
 API_PORT: 1312,
 API_STORE_PATH: 'build/store/pigeonposse.json'
} )

node standard-server.js
## Override OPTION
DEBUG=true node standard-server.js

本地服务器

import { createLocalServer } from '@pigeonposse/api-2026' // OR: import { createLocalServer } from '@pigeonposse/api-2026/server'

createLocalServer( {
 DEBUG: 'false',
 GH_TOKEN: "your-github-token",
 GH_USER: 'angelespejo',
 GH_BRANCH: 'main',
 GH_USER_TYPE: 'user',
 API_PORT: 1312,
 API_STORE_PATH: 'build/store/pigeonposse.json'
} )

node local-server.js
## Override OPTION
DEBUG=true node local-server.js

自定义服务器

您可以只使用应用程序，以建立您的服务器，无论你想要的。

标准的应用

import { appStandard } from '@pigeonposse/api-2026' // OR: import app from '@pigeonposse/api-2026/standard'

// Build you server

本地应用程序

import { appLocal } from '@pigeonposse/api-2026' // OR: import app from '@pigeonposse/api-2026/local'

// Build you server

更改环境变量

import { ENV } from '@pigeonposse/api-2026' // OR: import { ENV } from '@pigeonposse/api-2026/env'

ENV.DEBUG = 'true'
ENV.GH_USER='angelespejo'
ENV.GH_BRANCH='main'
ENV.GH_USER_TYPE='user'

// Do something

在存储库中添加自定义配置

这个包使用Collectium Github Preset来获取Github数据。有关更多信息，请阅读 文档