https://github.com/taciturnaxolotl/ddg-vcf

a contact dynamic card generator
https://github.com/taciturnaxolotl/ddg-vcf

duckduckgo hackclub vcard-site vcf

Last synced: about 2 months ago
JSON representation

a contact dynamic card generator

• Host: GitHub
• URL: https://github.com/taciturnaxolotl/ddg-vcf
• Owner: taciturnaxolotl
• License: agpl-3.0
• Created: 2023-11-26T00:26:25.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-28T15:54:21.000Z (about 1 year ago)
• Last Synced: 2024-12-08T06:29:22.721Z (about 2 months ago)
• Topics: duckduckgo, hackclub, vcard-site, vcf
• Language: JavaScript
• Homepage:
• Size: 1.39 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# DuckDuckGo email dynamic .vcf generation [![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/kcoderhtml/ddg-vcf)

# 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](assets/screenshot.jpeg)

# Installation

1. First you want to create your own copy of the repo by clicking the deploy to netlify button above.

3. Next configure your details in the [config/template.vcf](config/template.vcf) file. Edit the below lines but don't touch any of the other lines.

    ```vcf

    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

    ```

4. Change the photo in [config/template.vcf](config/photo.jpeg) to be your own photo. Ensure that it is 320x320px or smaller and it is a jpeg file.

5. Link your site with netlify with the following command:

    ```bash

    netlify link

    ```

6. Connect FaunaDB to your acount by running the commands below and following the prompts:

    ```bash

    netlify addons:create fauna

    netlify addons:auth fauna

    ```

7. Create two collections in Fauna `email_id_pairs` and `usage`

    ![photo of Fauna dashboard](assets/fauna_collections.png)

8. Create a new index in Fauna named `email_by_visit_id` with the settings shown in the image below:

    ![photo of Fauna index creation](assets/fauna_index.png)

9. Get your DuckDuckGo email protection api key by going to [https://duckduckgo.com/email/settings/autofill](https://duckduckgo.com/email/settings/autofill) and copying the token in the Authorization field:

    ![photo of network inspector](assets/ddg_api_key.png)

10. Add the api key to the Netlify environment variables for your site with the name `DUCK_API_SECRET`:

    ![netlify environment variable creation](assets/netlify_environment_variables.png)

11. 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](LICENSE.md)