digitalcredentials / admin-dashboard-claim-page

The claim page for collecting credentials from the admin-dashboard.

VC Claim Page

This open-source VC Claim Page is a joint effort between the Digital Credentials Consortium at MIT and the Learning Economy Foundation. It works with the Admin Dashboard to provide enterprises, schools, and organizations with a straightforward way to issue Verifiable Credentials in bulk.

Features of the admin-dashboard in general:

• User Management: Efficient user onboarding and management.
• Credential Management: Handle individual credentials—search, view, check status, and revoke.
• Batch Management: Manage groups of credentials, such as annual diploma issuances.
• VC & Email Template Management: Edit and store templates for credentials and emails.
• White Label Ready: Configurable branding options.
• VC-API & CHAPI Integration: Compatible with the Verifiable Credential API exchange endpoints and CHAPI.
• Deployment: Fully dockerized for ease of deployment.

And the claim page specifically:

• Claim Page: Allows students to claim and download their credentials to a wallet.
• QR SCan: Scan from mobile to open wallet on mobile.

Contributing

Pull requests are welcome.

Claim Page

This app serves the webpage that users see when claiming a credential.

It typically runs as a docker service in a docker compose network.

The app is configured by default to run at the path /claim. We've done this to more easily the allow the service to run within a docker compose network served on port 80 from a single domain, and to allow the publishing the docker image on DockerHub. If you'd like to change the path take a look at ./src/pages/index.astro and ./astro.config.mjs

Similarly the app makes calls back to the admin-dashboard API assuming that the api is running on the same server, on port 80, at /api. Or, if the claim page is running on localhost, it will call the dashboard api at localhost:3000/api. If you'd like to change these, take a look at ./src/pages/index.astro.

🚀 Project Structure

The VC Claim page uses Astro.

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

We've put Astro/React/Vue/Svelte/Preact components in src/components/.

Any static assets, like images, can be placed in the public/ directory.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command	Action
npm install	Installs dependencies
npm run dev	Starts local dev server at localhost:4321
npm run dev-local	Starts local dev server at locahost:8080
npm run build	Build your production site to ./dist/
npm run preview	Preview your build locally, before deploying
npm run astro ...	Run CLI commands like astro add, astro check
npm run astro -- --help	Get help using the Astro CLI

License

MIT © MIT