Quickstart application

Not sure how to get started? Try out our Quickstart application to see just how easy it is 😎.

Our Quickstart application, available for node, python, and ruby, allows you to quickly deploy a sample application to start interacting with the Belvo API.

Prerequisites

Please make sure that you have the following software installed:

  • Docker 19+
  • docker-compose 1.25+
  • GNU Make

Additionally:

Steps

To run the Quickstart application:

  1. Clone the repository:
    git clone https://github.com/belvo-finance/quickstart.git

  2. Navigate to the quickstart folder:
    cd quickstart/

  3. In the command line, paste in the following code, where:

  • [SECRET_ID] is your Belvo secret ID.
  • [SECRET_PASSWORD] is your Belvo secret password.
  • [CHOOSE_ENVIRONMENT] with either sandbox or production. This must align with your secret ID and secret password.
  • [CHOOSE_LIBRARY] with either python, node, or ruby.
echo
"BELVO_SECRET_ID=[SECRET_ID]
BELVO_SECRET_PASSWORD=[SECRET_PASSWORD]
BELVO_ENV=[CHOOSE_ENVIRONMENT]
CONTEXT=[CHOOSE_LIBRARY]" >> .env

This will create an .env file in the quickstart folder.

  1. Run the Quickstart app by entering make run in your console.

✳️ Done! Now just open up your local URL (http://localhost:8080) in your browser and run through the Widget process!

And here's a video, just in case you get stuck 😉.


Did this page help you?