Giter Site home page Giter Site logo

quackalias's Introduction

QuackAlias

QuackAlias is a simple email alias generator web application.

Usage

1. Obtain the DuckDuckGo API Key:

From here, follow these steps closely:

  • From DuckDuckGo’s email autofill page, right-click anywhere on the page and select “Inspect” from the context menu.

Image 1

  • In the developer tools panel, click the “Network” tab at the top.

Image 2

  • On the DuckDuckGo site next to the sidebar, click the “Generate Private Duck Address” button.

  • In the developer panel sidebar, click on the word “addresses.”

Image 3

  • Scroll down until you see the words “authorization: Bearer,” followed by a long string of letters and numbers.

  • Copy the long string of letters and numbers (without the “authorization: Bearer” portion) to your clipboard.

2. Clone the repository:

git clone https://github.com/Megane0103/quackalias.git

3. Install dependencies for backend:

cd quackalias/backend
npm install

4. Create the config.js file in the backend directory:

In the backend directory, create a file named config.js and add the following content:

// config.js
export const DUCKDUCKGO_API_KEY = '';
export const MONGODB_URI = '':

5. Paste the API key into the config.js file:

Paste the copied API key into the DUCKDUCKGO_API_KEY variable within the config.js file in the backend directory.

6. Set up MongoDB Atlas:

  • Create an account on MongoDB Atlas and set up a cluster.
  • Create a database and a collection (e.g., emailAliases).
  • Obtain the connection string for your MongoDB Atlas cluster.

7. Update backend/server.mjs to connect to MongoDB Atlas:

  • Replace MONGODB_URI variable in config.js with your MongoDB Atlas connection string.

8. Start the server:

cd ../backend
node server.mjs

9. Open index.html in your browser to use QuackAlias.

Features

  • Generate email aliases with a click of a button.
  • Copy generated email aliases to the clipboard.
  • View history of generated aliases and delete them if needed.

Technologies Used

  • Frontend: HTML, CSS, JavaScript
  • Backend: Node.js, Express.js, MongoDB Atlas
  • API: DuckDuckGo Email Alias API

Contributing

Contributions are welcome! Please fork this repository and create a pull request with your changes. For major changes, please open an issue first to discuss what you would like to change.

quackalias's People

Contributors

megane0103 avatar defaltastra avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.