Skip to content

onoja24cash-code/proxypay-frontend

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ProxyPay API Docs Portal

Docusaurus-based documentation site for the ProxyPay — Mobile Money ↔ Stellar Bridge API.

Getting started

npm install
npm start        # dev server on http://localhost:3001
npm run build    # production build → build/
npm run serve    # serve the production build locally

OpenAPI spec

The API reference page (/api) is powered by Redoc. It reads static/openapi.yaml at build time.

To populate the spec from the backend:

  • Option A — copy manually: cp ../proxypay/openapi.yaml ./static/openapi.yaml
  • Option B — fetch from a running backend: curl http://localhost:3000/docs/openapi.json -o static/openapi.yaml

A placeholder spec is committed so the project builds out of the box.

Deploy

Configured for GitHub Pages under sublime247/proxypay.

npm run deploy

About

ProxyPay API documentation portal

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 79.5%
  • CSS 20.5%