Skip to content

teddav/zk-tenant

Repository files navigation

zkTenant

Noir

zkTenant is an app designed to verify 2D-Doc documents to create a housing application without sharing more information than necessary.

How it works

The app allows you to share proof that you are French and that your income is higher than a certain amount without disclosing any other detail. For this, it uses your tax certificate and your French ID, both of which being signed with 2D-Doc.

2D-Doc is a structured digital signature standard widely used for secure document authentication.

Components:

  • 2D-Doc barcode for documents, used with:
    • Tax certificate document
    • Post-2021 French ID card
  • tdd.nr (based on Noir): ensuring efficient and privacy-preserving computations.

How to run

To set up the project locally:

  1. Clone the repository:
git clone https://github.com/teddav/zk-tenant.git
  1. Install dependencies:
cd zk-tenant
npm install
  1. Run the development server:
npm run dev

This will start the Next.js development server.


Contributing

Contributions are welcome! To get started:

  • Fork this repository.
  • Create a feature branch for your changes.
  • Submit a pull request detailing your improvements.

Sponsor

This project is supported by Hyli, the new proof-powered L1 to build the next generation of apps, as part of the Hyli grant program.

About

Resources

Stars

Watchers

Forks

Contributors