Skip to content

codeforpakistan/pehchan-portal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

45 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pehchan 🆔

A unified digital identity framework for Pakistan, built on Keycloak to enable secure, seamless access to digital services.

Next.js Tailwind Keycloak

Overview

Pehchan transforms Pakistan's identity infrastructure for the digital era. By providing a single, secure digital identity that works across government and private services, Pehchan eliminates the need for multiple credentials while ensuring user privacy and data control.

Key Features

  • Universal Access: Single sign-on across multiple services
  • Privacy-First Design: Advanced encryption and zero-knowledge proofs
  • User Control: Granular consent settings for data sharing
  • Modern Stack: Built with Next.js, Tailwind CSS, and shadcn/ui
  • Open Standards: Powered by Keycloak for robust identity management

Getting Started

Prerequisites

  • Node.js 18.x or later
  • Docker (for running Keycloak locally)
  • PostgreSQL

Installation

  1. Clone the repository:
git clone https://github.com/codeforpakistan/pehchan.git
cd pehchan
  1. Install dependencies:
npm install
  1. Set up environment variables:
cp .env.example .env.local
  1. Start Keycloak using Docker:
docker-compose up -d
  1. Run the development server:
npm run dev

Visit http://localhost:3000 to see the application.

Architecture

Pehchan is built with:

  • Next.js: For server-side rendering and API routes
  • Tailwind CSS: For utility-first styling
  • shadcn/ui: For beautiful, accessible components
  • Keycloak: For identity and access management

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Workflow

  1. Fork the repository
  2. Create a feature branch
  3. Commit your changes
  4. Push to your fork
  5. Submit a pull request

Integration Guide

Adding Pehchan to Your Service

TBA

Found a security issue? Please report it through our Security Policy.

Roadmap

  • Core authentication system
  • Integration with government services
  • Mobile application
  • Biometric authentication
  • Private sector partnerships
  • Digital signature capabilities

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • Inspired by GOV.UK Verify and Singapore's Singpass
  • Supported by the Civic Innovators Program

Built with ❤️ for Pakistan 🇵🇰

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •