Decentralized Digital Identity and Verifiable Credentials for Communities
Find a file
2024-01-23 11:09:38 +01:00
.gitea/workflows Introduce env vars manually 2024-01-14 20:16:20 +01:00
examples readme of examples 2024-01-23 11:01:51 +01:00
idhub update migrations 2024-01-22 18:13:28 +01:00
idhub_auth update migrations 2024-01-22 18:13:28 +01:00
locale add translation 2023-11-28 10:17:59 +01:00
oidc4vp update migrations 2024-01-22 18:13:28 +01:00
promotion update migrations 2024-01-22 18:13:28 +01:00
schemas add more credentials type 2024-01-21 21:08:43 +01:00
trustchain_idhub change LANG_CODE 2024-01-22 16:03:17 +01:00
utils resolve conflict 2024-01-20 15:28:42 +01:00
.gitignore merged from base 2023-10-10 08:46:30 +02:00
LICENSE.md update readme 2024-01-23 10:07:44 +01:00
manage.py Started django project + first HTML render 2023-09-26 09:15:28 +02:00
pyproject.toml rebuild flow of import datas 2023-10-24 14:08:24 +02:00
README.md Updated license name 2024-01-23 11:09:38 +01:00
requirements.txt resolve conflict step1 2024-01-22 14:04:06 +01:00

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

  1. Clone the repository:
    git clone [FINAL GitHub LINK]
    
  2. (Recommended but optional) Create and activate a virtual environment:
    python -m venv venv
    source venv/bin/activate
    
  3. Install the required packages:
    pip install -r requirements.txt
    
  4. Run migrations:
    python manage.py migrate
    
  5. Optionally you can install a minumum data set:
    python manage.py initial_datas
    
  6. 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 GNU Affero General Public License - see the LICENSE.md file for details.

Further Reading

  • ...