@flourish/live-api

5.2.1 • Public • Published

To get started developing the API:

  1. Clone the Flourish API demo and follow the instructions to set it up.

  2. Link the local version of the API, then start the API demo:

    (cd $WHEREVER/flourish/api && npm link) cd $WHEREVER/flourish-api-demo npm link @flourish/live-api npm start

  3. Start Flourish locally, and obtain a local API key if you don't already have one.

  4. Open the running API demo on http://localhost:8888/?local=1 (NB: the local=1 parameter ensures this is run against your local Flourish server). Enter your local API key when requested.

  5. Finally, to see the effects of your changes: edit the API code in this directory, and run npm run build inside flourish/api.

NB: each time you want to see a new change propagate, you'll need to rerun npm run build and restart the API demo.

Readme

Keywords

none

Package Sidebar

Install

npm i @flourish/live-api

Weekly Downloads

2,476

Version

5.2.1

License

UNLICENSED

Unpacked Size

1.17 MB

Total Files

9

Last publish

Collaborators

  • scottb-flourish
  • jontyt
  • rushlet
  • winna_canva
  • bruno-riddy
  • libruca
  • jwitcombe
  • katietannercanva
  • b3n-canva
  • caletilford
  • florin.oprina
  • robinhouston
  • duncanclark
  • daanlouter
  • hughsk
  • mark-kiln
  • animateddata
  • larsvers
  • luptilu
  • bobbysebolao
  • hrobertson
  • oampo