|
| 1 | +# CREDEBL UI User Guide |
| 2 | + |
| 3 | +## Introduction |
| 4 | +CREDEBL is an open-source Self-Sovereign Identity (SSI) and Verifiable Credentials platform. |
| 5 | +This guide helps users navigate the CREDEBL User Interface (UI) efficiently. |
| 6 | + |
| 7 | +## Accessing the Platform |
| 8 | +1. Open your browser. |
| 9 | +2. Navigate to your environment: |
| 10 | + - Local development: `http://localhost:5000` |
| 11 | + - Hosted environment: as provided by your administrator |
| 12 | +3. Log in using your credentials or developer account for local setups. |
| 13 | + |
| 14 | +## Dashboard Overview |
| 15 | +- **Users**: Manage users and their credentials. |
| 16 | +- **Ledger**: View issued credentials and verification history. |
| 17 | +- **Organizations**: Manage organizational accounts and credentials. |
| 18 | +- **Connections**: Track SSI connections and their status. |
| 19 | +- **Issuance & Verification**: Issue credentials or verify existing ones. |
| 20 | + |
| 21 | +## Navigation |
| 22 | +- Use the **sidebar menu** to switch between modules. |
| 23 | +- Hover over icons to see tooltips explaining their functions. |
| 24 | +- Use search bars and filters to quickly locate records. |
| 25 | + |
| 26 | +## Modules |
| 27 | + |
| 28 | +### Users |
| 29 | +- **Add User**: Fill required fields and click *Create*. |
| 30 | +- **Search Users**: Filter by ID, name, or email. |
| 31 | +- **View Details**: Click on a user to view full credentials and history. |
| 32 | + |
| 33 | +### Ledger |
| 34 | +- Lists all issued credentials with columns like credential ID, type, issuer, and status. |
| 35 | +- Filter results by type, status, or date range. |
| 36 | + |
| 37 | +### Organizations |
| 38 | +- **Add Organization**: Provide name, type, and assign credentials. |
| 39 | +- **Manage Credentials**: Assign, revoke, or view credentials for organizations. |
| 40 | + |
| 41 | +### Connections |
| 42 | +- Shows active SSI connections including status, last activity, and associated users. |
| 43 | +- Use filters to locate specific connections. |
| 44 | + |
| 45 | +### Issuance & Verification |
| 46 | +- **Issue Credential**: |
| 47 | + 1. Select credential type. |
| 48 | + 2. Choose recipient (user or organization). |
| 49 | + 3. Fill required fields. |
| 50 | + 4. Click *Issue Credential*. |
| 51 | +- **Verify Credential**: |
| 52 | + 1. Enter credential ID. |
| 53 | + 2. System checks ledger. |
| 54 | + 3. Displays verification result. |
| 55 | + |
| 56 | +## Best Practices |
| 57 | +- Verify credentials before issuing. |
| 58 | +- Ensure all environment variables are correctly configured. |
| 59 | +- Restart services if UI is not reflecting updates. |
| 60 | + |
| 61 | +## Troubleshooting |
| 62 | +- **UI not accessible**: Confirm API Gateway and microservices are running. |
| 63 | +- **Credential issuance errors**: Check Prisma database schema and restart services. |
| 64 | +- **UI outdated**: Clear browser cache or restart frontend. |
| 65 | + |
| 66 | +## Additional Resources |
| 67 | +- [CREDEBL GitHub Repository](https://github.com/credebl/platform) |
| 68 | +- [Backend Setup & Environment Guide](README.md) |
| 69 | +- [Docker & NATS Documentation](https://docs.docker.com/) |
| 70 | + |
| 71 | +--- |
| 72 | + |
| 73 | +*This guide is maintained by contributors and will be updated as CREDEBL evolves.* |
0 commit comments