This project is a Promotional Email Sending Web Application designed to send targeted promotional emails to customers based on specific segmentation criteria. It utilizes Express.js for the server-side framework and Redis for implementing a publish-subscribe (pub-sub) messaging system, ensuring efficient handling of email notifications. This project was an assignment from Xeno and was built within 5 days.
- Segmented Email Campaigns: Create customer segments based on specified criteria such as purchase history, and engagement levels.
- Real-time Notifications: Leverage Redis pub-sub for real-time email sending logs.
- User-friendly Interface: A web-based interface that allows users to easily manage email campaigns and customer segments.
- Scalable Architecture: Built to handle a large number of emails and customers efficiently.
- Express.js: A web application framework for Node.js, used to build the server-side application.
- Redis: An in-memory data structure store used for pub-sub messaging, allowing real-time communication between different parts of the application.
- Next.js with typescript
- Nodemailer: A module for Node.js to send emails easily.
To set up the project locally, follow these steps:
-
Clone the repository:
git clone <repository-url> cd <repository-directory>
-
Install dependencies:
npm install
-
Set up Redis:
- Ensure Redis is installed and running on your machine. You can download it from Redis.io.
-
Configure environment variables:
- Create a
.envfile in the root directory and add your email service credentials and Redis configuration.
- Create a
-
To run the client and server in development:
npm run dev: client npm run dev: server
