Skip to content
/ ddg-vcf Public template

a contact dynamic card generator

License

Notifications You must be signed in to change notification settings

kcoderhtml/ddg-vcf

Repository files navigation

DuckDuckGo email dynamic .vcf generation Deploy to Netlify

Introduction

This project dynamically generates a .vcf file with a new duck address for each unique hardware id. It was designed for the OnBoard event hosted by Hack Club.

screenshot of webapp

Installation

  1. First you want to create your own copy of the repo by clicking the deploy to netlify button above.
  2. Next configure your details in the config/template.vcf file. Edit the below lines but don't touch any of the other lines.
    N:Klukas;Kieran;;;
    FN:Kieran Klukas
    BDAY:2008-04-27
    GENDER:male
    NICKNAME:kieran
    URL;TYPE=HOME:https://kieranklukas.com
    URL;TYPE=SOCIAL:https://www.youtube.com/@wanderer.archives
    URL;TYPE=SOCIAL:https://scrapbook.hackclub.com/Kieran
  3. Change the photo in config/template.vcf to be your own photo. Ensure that it is 320x320px or smaller and it is a jpeg file.
  4. Link your site with netlify with the following command:
    netlify link
  5. Connect FaunaDB to your acount by running the commands below and following the prompts:
    netlify addons:create fauna
    netlify addons:auth fauna
  6. Create two collections in Fauna email_id_pairs and usage photo of Fauna dashboard
  7. Create a new index in Fauna named email_by_visit_id with the settings shown in the image below: photo of Fauna index creation
  8. Get your DuckDuckGo email protection api key by going to https://duckduckgo.com/email/settings/autofill and copying the token in the Authorization field: photo of network inspector
  9. Add the api key to the Netlify environment variables for your site with the name DUCK_API_SECRET: netlify environment variable creation
  10. Rebuild the site on netlify and Profit! You can add the url of your netlify site to your nfc card and share it with people to give them your contact information while still retaining the privacy of your email and the ability to remotely disable that specific address.

License

This repositories code is licensed with the GNU AFFERO GENERAL PUBLIC LICENSE you can view it here