Skip to content

dvla/lab-gen-ui

Repository files navigation

DVLA Emerging Tech Lab Generative AI

This project provides the frontend for the generative AI experiments which can be used in conjunction with the lab-gen-api backend.

Getting Started

Prerequisites

Install the packages

npm install

Quick Start

Open in GitHub Codespaces

Open in VS Code Dev Containers

Create .env.local file in the project root, with the following -

AZURE_APP_HOST={BACKEND_URL}
AZURE_APP_API_KEY={MUST_MATCH_THE_BACKEND_API_KEY}
AUTH_SECRET={CREATE_RANDOM_SECRET}
AUTH_URL={http://localhost:3000 or your codespaces URL eg. https://candy-bus-jwvrg-3000.app.github.dev}

Local Development

For local development, you can use a local password for authentication by setting the AUTH_LOCAL_PASSWORD environment variable in your .env.local file:

AUTH_LOCAL_PASSWORD=passw0rd

This will allow you to sign in with the local credentials provider using the password you set. This should only be used for local development.

Production

For production, you should use AWS Cognito for authentication. Set the following environment variables for the AWS Cognito authorization. These can be configured in an AWS console.

AUTH_COGNITO_CLIENT_ID=123
AUTH_COGNITO_CLIENT_SECRET=123
AUTH_COGNITO_ISSUER=https://cognito.eu-west-2.amazonaws.com/eu-west-2_12345678

You can then run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

Codespaces

Open in GitHub Codespaces

This project can be run in GitHub Codespaces. If you are running the project alongside the backend (also in Codespaces), you will need to ensure the backend forwarding port is set to 'public' to enable it to be accessible. Ensure the AUTH_URL is also set correctly to match the codespaces app url as described in the quick start.

Development

This uses the govuk-react framework. The storyboard has examples of components you can use.

More details of the components can be found in the Components Guide.

License

The MIT License (MIT)

Copyright (c) 2024 DVLA

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Emerging Tech Lab Generative AI Frontend

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published