Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions CREDEBL-UI-User-Guide.md
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking if we could maybe add this as a page inside the guides section. Just rename the section as UI User guide. Or maybe add a subsection under it. Even though I'm not really sure what other guides we might have apart from the UI User guide for now

Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# CREDEBL UI User Guide

## Introduction
CREDEBL is an open-source Self-Sovereign Identity (SSI) and Verifiable Credentials platform.
This guide helps users navigate the CREDEBL User Interface (UI) efficiently.

## Accessing the Platform
1. Open your browser.
2. Navigate to your environment:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit unsure of why we are navigating to the backend if its the UI guide??

For UI, we can have localhost:3000

- Local development: http://localhost:5000
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Local development: http://localhost:5000
- Local development: http://localhost:5000/api

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its not currently auto redirected to /api for now. Have a look at this issue: credebl/platform#1527

- Hosted environment: as provided by your administrator
3. Log in using your credentials or developer account for local setups.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or developer account

Do you mean using the client credentials here?


## Dashboard Overview
- **Users**: Manage users and their credentials.
- **Ledger**: View issued credentials and verification history.
- **Organizations**: Manage organizational accounts and credentials.
- **Connections**: Track SSI connections and their status.
- **Issuance & Verification**: Issue credentials or verify existing ones.

## Navigation
- Use the **sidebar menu** to switch between modules.
- Hover over icons to see tooltips explaining their functions.
- Use search bars and filters to quickly locate records.

## Modules

### Users
- **Add User**: Fill required fields and click Create.
- **Search Users**: Filter by ID, name, or email.
- **View Details**: Click on a user to view full credentials and history.

### Ledger
- Lists all issued credentials with columns like credential ID, type, issuer, and status.
- Filter results by type, status, or date range.

### Organizations
- **Add Organization**: Provide name, type, and assign credentials.
- **Manage Credentials**: Assign, revoke, or view credentials for organizations.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assign, revoke, or view credentials for organizations.

Not sure about this.

Do you mean inviting user and giving them different roles? (ORG invitation part)


### Connections
- Shows active SSI connections including status, last activity, and associated users.
- Use filters to locate specific connections.

### Issuance & Verification
- **Issue Credential**:
1. Select credential type.
2. Choose recipient (user or organization).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

organization

I'm not sure if we have this ability yet.

Can you please elaborate what exactly you mean here

3. Fill required fields.
4. Click Issue Credential.
- **Verify Credential**:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually here a more suited word would be sending a verification request similar to that of issuing credential

1. Enter credential ID.
2. System checks ledger.
3. Displays verification result.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It makes sense her ig to have some hints of using a wallet to store credentials. Something like https://play.google.com/store/apps/details?id=id.credebl.adeya and https://apps.apple.com/in/app/sovio-wallet-adeya-wallet/id6463845498


## Best Practices
- Verify credentials before issuing.
- Ensure all environment variables are correctly configured.
- Restart services if UI is not reflecting updates.

## Troubleshooting
- **UI not accessible**: Confirm API Gateway and microservices are running.
- **Credential issuance errors**: Check Prisma database schema and restart services.
- **UI outdated**: Clear browser cache or restart frontend.

## Additional Resources
- CREDEBL GitHub Repository: https://github.com/credebl/platform
- Backend Setup & Environment Guide: README.md
- Docker Documentation: https://docs.docker.com/
- NATS Documentation: https://docs.nats.io/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this links, maybe having link to the local-deployment section would be more appropriate


---

*This guide is maintained by contributors and will be updated as CREDEBL evolves.*