Trustworthy & Ethical Assurance Platform¶

TEA (Trustworthy & Ethical Assurance) Platform is a web application developed using Next.js, React, and TypeScript. It provides a platform for managing and monitoring assurance cases in various domains.

Getting Started¶

Demo: Create Assurance Case with Goals, Claims and Strategies

To get started with Assurance Platform, follow these steps:

Prerequisites¶

Node.js and npm (or Yarn) installed on your machine.
Have the API backend running locally

Installation¶

Clone the repository:

git clone https://github.com/alan-turing-institute/AssurancePlatform.git

Navigate to the project directory:
```
cd next-frontend
```
Install dependencies using npm:
```
npm install
```

Development¶

To run the application in development mode, navigate to this directory and use the following command.

npm run dev

This command starts the development server and opens the application in your default web browser. The application will automatically reload if you make any changes to the source code.

Production¶

To build and run the application in production mode, use the following command

npm run build
npm start

This will build the application for production and start a server to serve the built files.

Configuration¶

The application uses environment variables for configuration. Create a .env.local file in the root directory and specify the required environment variables. You can use the .env.example file as a template.

Environment Variables Example¶

GITHUB_APP_CLIENT_ID={gh-clientid-value}
GITHUB_APP_CLIENT_SECRET={gh-secret-valie}
NEXTAUTH_SECRET={unique-string}
NEXT_PUBLIC_API_URL={api-url-value}
API_URL={api-url-value}
NEXTAUTH_URL={frontend-url-value}

To generate a unique string for the NEXTAUTH_SECRET you can run:

openssl rand -base64 32