Code Monkey home page Code Monkey logo

email-beacon's Introduction

email-beacon

A simple POC for an email tracking app. Has 3 API's

  1. Subscribe API - accepts raw JSON input with only one parameter of email with a value of the email address whom we want to add to our subscription database.

Example input: { email: "[email protected]" }

  1. Image api - accepts two params using a get request, the first one being the API key and the second one being the filename requested. The system leverages the JSON Web Token api to fetch encrypted data to avoid a db search request.

Example URL call: https://$HOST/$apikey/$filename

It is recommended to use an https server, because most email clients will reject the image. I recommended using c9.io to run this project because they support https requests.

  1. Logs api - Implemented temporarily to check the log file.

Example URL call: https://$HOST/logs

Installation Steps:

  1. Clone the repo.
  2. Create a logs folder in root and create an empty file logs.txt inside that logs folder.
  3. Add email details in config/emailConfig.js file.
  4. run npm install
  5. run npm start

email-beacon's People

Contributors

aakashthakkar avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

mabdelwanis

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.