3.3 KiB

Raw Blame History

IdHub

IdHub is a Django-based project designed to provide efficient identity management solutions. This README offers an overview of the project, setup instructions, and additional resources.

About IdHub

IdHub aims to streamline the process of identity management by leveraging the power and flexibility of Django. It's ideal for organizations looking for a reliable, scalable, and customizable identity management system.

Features

Admin Dashboard: A user-friendly admin panel for managing identities.
Identity Verification: Tools and interfaces to verify and manage identities.
...

Getting Started

Prerequisites

Python 3.x

Installation

Clone the repository:
```
git clone [FINAL GitHub LINK]
```
(Recommended but optional) Create and activate a virtual environment:
```
python -m venv venv
source venv/bin/activate
```
Install the required packages:
```
pip install -r requirements.txt
```
Run migrations:
```
python manage.py migrate
```
Optionally you can install a minumum data set:
```
python manage.py initial_datas
```
Start the development server:
```
python manage.py runserver
```

Usage

Access the application at http://localhost:8000.

Running Tests

IdHub uses Django's built-in testing tools to ensure the reliability and performance of the application. Follow these steps to run the tests:

Execute the following command in your project directory to run all tests:

python manage.py test

This command will discover and run all tests in the tests directories of the application.

Repository Structure

IdHub's repository is organized into several directories, each serving a specific purpose in the project:

examples: ???
idhub: The core directory of the IdHub project. It includes the main functionality of this Django project.
idhub_auth: This directory is dedicated to the authentication system of IdHub. It includes modules and configurations for user authentication and authorization.
locale: Contains localization files for IdHub, enabling support for multiple languages. It's crucial for making the project accessible to a global audience.
oidc4vp: This folder is specific to OpenID Connect for Verifiable Presentations (OIDC4VP) integration, a protocol for handling verifiable credentials in a standardized way.
promotion: Contains an example application for a verification portal.
schemas: Contains verifiable credential schemas used within IdHub. These include some schemas from the [schemas repository], which are copied here to avoid losing access in case of encountering connection problems.
ssikit_example_src: Source code examples demonstrating the usage of SSI (Self-Sovereign Identity) Kit, providing insights into how IdHub integrates with SSI concepts.
trustchain_idhub: This folder includes settings and configurations for the Django project.
utils: A utility folder containing various helper scripts and tools that aid in the development and maintenance of the IdHub project.

Documentation

For detailed documentation, visit [Documentation Link].

License

This project is licensed under the [License Name] - see the LICENSE.md file for details.

3.3 KiB Raw Blame History