VGI API and WebApp

Check out our demonstration website.

API/Backend

The VGI API is written in FastAPI and run in production via Azure Functions.

The project directory contains the following folders

vgi_api/
azure_funcs/

vgi_api is the VGI API (a python package).

azure_funcs is the Azure Function App which runs vgi_api in production.

WebApp

If you're on Windows and don't have Node.js installed, you can install it from here https://nodejs.org/en/download/ The Node.js installer includes the NPM package manager.

Project setup

npm install

Compiles and hot-reloads for development

npm run serve

You can change the API endpoint by altering .env.development which defaults to http://127.0.0.1:8000.

This assumes you are running the API server locally, which you can do with:

cd vgi_api && poetry run uvicorn vgi_api:app --reload --port 8000

If you want to use the production API (i.e. on Azure) change the contents of .env.development to match that in .env.production.

Compiles and minifies for production

npm run build

Lints and fixes files

npm run lint

Customize configuration

See Configuration Reference.