@pigeonposse/api-2024 NPM

PIGEONPOSSE API

Run the PigeonPosse API.

Rest API to get data from your GitHub repository.

Required for @pigeonposse/web-2024

Prerequisites

GitHub Token Read more

Installation

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

CLI Usage

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

Or with a installation

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

Library Usage

Standard server

import { createServer } from '@pigeonposse/api-2024' // OR: import { createServer } from '@pigeonposse/api-2024/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

Local server

import { createLocalServer } from '@pigeonposse/api-2024' // OR: import { createLocalServer } from '@pigeonposse/api-2024/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

Custom server

You can use only the app, for build your server wetheaver you want.

Standard app

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

// Build you server

Local app

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

// Build you server

Change enviroment variables

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

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

// Do something