Skip to content
Dipen Patel edited this page Nov 6, 2024 · 1 revision

Welcome to the DID-Django Wiki!

Welcome to the official documentation and knowledge base for the DID-Django project! This wiki is intended to guide developers and contributors through setup, configuration, and usage of the DID-Django application.


Table of Contents

  1. Project Overview
  2. Features
  3. Getting Started
  4. Installation
  5. Configuration
  6. Usage
  7. Contributing
  8. License

Project Overview

DID-Django is a Django-based application that leverages decentralized identifiers (DIDs) for secure, self-sovereign identity management. This project aims to provide a robust backend framework for managing DIDs, integrating them into existing Django workflows, and supporting innovative identity solutions.

Features

  • DID Management: Create, manage, and validate decentralized identifiers within Django.
  • Self-Sovereign Identity: Enables users to control their identities independently.
  • API Integration: Provides REST API endpoints for secure identity management.
  • Flexible Authentication: Supports various authentication methods, including DID-based login.

Getting Started

To get started with the DID-Django project, clone the repository and follow the instructions below to set up and configure the project on your local machine.

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/DID-django.git
    cd DID-django
  2. Create a virtual environment:

    python3 -m venv venv
    source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
  3. Install the dependencies:

    pip install -r requirements.txt
  4. Set up the database:

    python manage.py migrate
  5. Create a superuser:

    python manage.py createsuperuser

Configuration

  1. Environment Variables: Configure environment variables in a .env file for sensitive information such as SECRET_KEY, DATABASE_URL, and any DID-specific settings.

  2. Settings: Adjust any additional settings in settings.py as required for your specific environment.

Usage

  1. Run the development server:

    python manage.py runserver
  2. Access the application: Open your browser and go to http://127.0.0.1:8000 to see the application in action.

Contributing

We welcome contributions from the community! To contribute to DID-Django:

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix.
  3. Make your changes and test thoroughly.
  4. Submit a pull request for review.

Please check out our Contribution Guidelines for detailed instructions.

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Clone this wiki locally