Code Monkey home page Code Monkey logo

ck_newsletter's Introduction

ck newsletter - A newsletter service

[Github]

This service aims to aid small and mid-sized bloggers to automate the process of delivering newsletters to subscribers. Blogger needs to hook two requests to their blog code and focus on writing amazing blogs. Your subscribers are going to receive the newsletters when you publish a new.

Table of contents:

  • How to create an account?
  • How to create a project?
  • How to activate newsletter service?
  • Set-up the subscribe.
  • Set-up the push newsletters.

How to create an account?

  1. Open the cknewsletter.herokuapp.com
  2. Sign up with your email account.

How to create a project?

  1. Sign In with your account credentials.

  2. Click on new to create a new project.

  3. Fill details about your project.

    • Optionally, you can set-up your custom ( HTML ) newsletter template.
  4. Submit it.

How to activate newsletter service?

These email credentials will be used to send newsletters to your subscribers.

  1. You need to go to the profile page.

  2. Put your email and password credential to the relative input fields.

  3. Select your email service.

  4. Save it.

Set-up the subscribe!

  1. Create a fetch request with PATCH method.

  2. Need to put two properties into the payload ( body ). { "subscriber": "***@gmail.com", "apiKey": "15870449476249g9uo****" }

    • The subscriber should be dynamic. It should be your subscriber's email.
    • The apiKey should be your project's API Key.
  3. Now you can make a patch request with these data on this endpoint: https://cknewsletter.herokuapp.com/api/v1/projects/subscribe

  4. Your subscribers will be stored in this project's data.

  5. Place this code in your blog's code where it will be invoked whenever your user submit the subscribe form.

Set-up the push newsletters!

  1. Create a fetch request with PATCH method.

  2. Need to put two properties into the payload ( body ). { "slug": "vue", "apiKey": "15870449476249g9uo****" }

    • Replace the apiKey with your project's API key.
    • Slug should be dynamic. Your article slug or id should be the value of slug key.
  3. Notice that your slug will be used to create the link to your article. For Ex: "https://myblog.com/blog/vue"

  4. Now you can make a patch request with these data on this endpoint: https://cknewsletter.herokuapp.com/api/v1/projects/slug

  5. Place this patch request code to your blog code where it makes this request every time whenever you publish a new article.

  6. It will push the newsletter to your subscribers of particular project.

Voila, You are done now. Now write the best and keep your subscribers in sync with your latest articles.

Support

Feel free to reach out to me on [email protected]

License

This project is MIT licensed unless otherwise specified.

ck_newsletter's People

Contributors

ckbhatia avatar

Watchers

James Cloos 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.