Git Product home page Git Product logo

nwo-newsletter's Introduction

NWO Newsletter

This POC API allows subscribing to a newsletter with specific "industry", "source", and "subcategory" of the news. You can subscribe to as many industries, sources and subcategories as desired.

Installation

  • Install sqlite3
  • Install node v22.0.0
  • Clone the repository
  • Navigate to the project directory and run npm install
  • Run npm run db:migrate to set up the database
  • Run npm start to start the server on port 3000
    • To start the server in development mode, run npm run dev

Testing

To run the E2E tests, run npm test

API Endpoints

POST /subscribe

Subscribes to the newsletter for the provided "industry", "source" and "subcategory".

Example request with curl

curl -X POST localhost:3000/subscribe \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]", "industry": "tech", "source": "news", "subcategory": "new product releases"}'

Example response

{
	"subscription": {
		"id": 1,
		"email": "[email protected]",
		"industry": "tech",
		"source": "news",
		"subcategory": "new product releases"
	}
}

POST /unsubscribe

Unsubscribes from the newsletter for the provided "industry", "source" and "subcategory".

Example request with curl

curl -X POST localhost:3000/unsubscribe \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]", "industry": "tech", "source": "news", "subcategory": "new product releases"}'

Example response

{
	"subscription": {
		"id": 1,
		"email": "[email protected]",
		"industry": "tech",
		"source": "news",
		"subcategory": "new product releases"
	}
}

POST /unsubscribe_from_all

Unsubscribes from the newsletter for all industries, sources and subcategories.

Example request with curl

curl -X POST localhost:3000/unsubscribe_from_all \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]"}'

Example response

{
	"subscriptions": [
		{
			"id": 1,
			"email": "[email protected]",
			"industry": "tech",
			"source": "news",
			"subcategory": "new product releases"
		},
		{
			"id": 2,
			"email": "[email protected]",
			"industry": "beauty",
			"source": "news",
			"subcategory": "new product releases"
		}
	]
}

nwo-newsletter's People

Contributors

amiratak88 avatar

Watchers

 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.