Papupata Documentation

Table of contents

Getting Started

Requirements

Ensure your codebase meets the following requirements:

  • Node 10+ (if using papupata to implement APIs; this requirement can be removed fairly easily if there is demand to do so)
  • Typescript 3.4+
  • Express (again only if implementing APIs)

Installing papupata

npm i papupata
npm i -D @types/express

Implementing something simple

Setting everything up for doing requests from the browser involves the following steps:

  • Declaring the APIs
  • Configuring papupata on the server
  • Implementing the APIs on the server
  • Configuring papupata on the browser
  • Making the API calls

Take a look at the guides to help you along this journey.

Or if you prefer, you can look at the example app and API reference for how all of this can be done.