@flourish/live-api

    4.5.0 • 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.

    Keywords

    none

    Install

    npm i @flourish/live-api

    DownloadsWeekly Downloads

    35

    Version

    4.5.0

    License

    UNLICENSED

    Unpacked Size

    345 kB

    Total Files

    22

    Last publish

    Collaborators

    • axwalker
    • shar.k
    • flourish-canva
    • declanvong
    • pinkopunko
    • vee_canva
    • florin.oprina
    • robinhouston
    • duncanclark
    • daanlouter
    • timbrock
    • hughsk
    • mark-kiln
    • animateddata
    • larsvers
    • luptilu
    • bobbysebolao
    • liakouras
    • oliviajanelawlor
    • hrobertson
    • eademoon
    • qubyte
    • chrisnewell
    • oampo
    • sebr
    • alextreppass
    • wearymonkey
    • mattcarter-canva
    • marcfallows
    • mafecafe
    • connormj
    • simonaats