This website is built using Docusaurus 2, a modern static website generator. It contains information to help our partners integrate with Kiva's Partner API.
$ yarn
This command installs the necessary packages for building and running the site.
Run this command in the fps-sdk/portal directory:
$ yarn build
This will generate static content into the fps-sdk/portal/build directory and can be served using any static content
hosting service.
The build output will contain a directory for each locale present in docusaurus.config.js:
build- EN (default locale)build/es- ES (Spanish)build/fr- FR (French)
We are using Firebase to host the portal. Firebase is a Google service for hosting static websites. These instructions assume you have installed the Firebase CLI.
The following sections assume you have run the Install and Build steps.
Run the following command to start the emulator:
firebase emulator:start
The firebase.json is set up, so this is all that is needed. The site is at http://127.0.0.1:5000/. Once you are satisfied with your work, please follow the steps for creating a Preview site, and link that in your pull request!
You can find the steps for setting up a project with the emulator on Google's documentation for testing a site locally.
The Firebase project is located at https://console.firebase.google.com/project/fps-sdk-portal/hosting/sites. If you don't have access to this project, request it from one of the CODEOWNERS.
Firebase access is linked to your Google account. Please log in using your google account:
firebase login
Run these Firebase commands:
firebase use --add
firebase target:apply hosting dec2022 fps-sdk-portal
firebase deploy