Skip to content

Quickstart

Get a complete, working application running in less than 15 minutes. This guide walks you through cloning a pre-configured starter kit, configuring authentication, and running a minimal Next.js application that uses the Averer Web SDK.

Prerequisites

  • Node.js v18 or later
  • A GitHub account with a Personal Access Token (classic) that has the read:packages scope

Step 1: Clone the starter kit

We've created a pre-configured Next.js starter kit with the basic backend and frontend structure already in place so you can use it as a guide for your implementation.

git clone https://github.com/averer/averer-websdk-quickstart.git
cd averer-websdk-quickstart

Step 2: Install dependencies

npm install

Step 3: Setup env

Create a .env file by copying the .env.sample or use this command

cp .env.sample .env

Note: To obtain the VITE_CONFIG_ID, please contact Averer support.

Step 4: Run the application

The starter kit is configured to run both the backend verifier and the frontend application at the same time.

npm run dev

This starts the Next.js app at http://localhost:3000, where you can complete your first eligibility check using the Averer Web SDK.

Next steps

Ready to integrate the SDK into your own project? Head to the Installation guide.