Our Quickstart application, available for node, python, and ruby, allows you to quickly deploy a sample application to start interacting with the Belvo API.
Please make sure that you have the following software installed:
- Docker 19+
- docker-compose 1.25+
- GNU Make
- make sure that you have a valid Belvo secret key and password.
To run the Quickstart application:
Clone the repository:
git clone https://github.com/belvo-finance/quickstart.git
Navigate to the quickstart folder:
In the command line, paste in the following code to create an .env file in the quickstart folder.:
echo "BELVO_SECRET_ID=[SECRET_ID] BELVO_SECRET_PASSWORD=[SECRET_PASSWORD] BELVO_ENV=[CHOOSE_ENVIRONMENT] CONTEXT=[CHOOSE_LIBRARY] COMPANY_ICON_URL=[OPTIONAL_URL_TO_YOUR_COMPANY_ICON] COMPANY_LOGO_URL=[OPTIONAL_URL_TO_YOUR_COMPANY_LOGO] COMPANY_NAME=[OPTIONAL_YOUR_COMPANY_NAME] COMPANY_BENEFIT_HEADER=[OPTIONAL_BENEFIT_TITLE] COMPANY_BENEFIT_CONTENT=[OPTIONAL_BENEFIT_TEXT] COMPANY_OPPORTUNITY_LOSS=[OPTIONAL_EXIT_MESSAGE]" >> .env
echo "BELVO_SECRET_ID=secret-id BELVO_SECRET_PASSWORD=secret-password BELVO_ENV=sandbox CONTEXT=python COMPANY_ICON_URL=https://mysite.com/icon.svg COMPANY_LOGO_URL=https://mysite.com/logo.svg COMPANY_NAME=ACME COMPANY_BENEFIT_HEADER=Faster approvals COMPANY_BENEFIT_CONTENT=Using Belvo cuts down on your loan approval time by up to 15 days. COMPANY_OPPORTUNITY_LOSS=It can take up to 20 days to evaluate your request using traditional methods." >> .env
Check the table below for detailed information about each parameter. For more information about the branding parameters, check out our Branding and customization article.
Your Belvo secret ID.
You Belvo secret password.
The Belvo environment you want to use. Choose between
The programming language. Choose between
URL to your company icon.
URL to your company logo.
Your company name.
A title to your benefit message.
The content for your benefit message.
Message to display when someone decides to exit the widget.
- Run the Quickstart app by entering
make runin 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 😉.
Updated 2 months ago