https://github.com/mdaashir/pricetag
https://github.com/mdaashir/pricetag
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mdaashir/pricetag
- Owner: mdaashir
- Created: 2025-03-16T18:17:43.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2025-04-01T11:22:39.000Z (about 2 months ago)
- Last Synced: 2025-04-01T12:28:14.847Z (about 2 months ago)
- Language: TypeScript
- Homepage:
- Size: 2.8 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
A E-Comerce Price Tracking Application
## 📋 Table of Contents
1. 🤖 [Introduction](#introduction)
2. ⚙️ [Tech Stack](#tech-stack)
3. 🔋 [Features](#features)
4. 🤸 [Quick Start](#quick-start)
5. 🔗 [Links](#links)
Developed using Next.js and Bright Data's webunlocker, this e-commerce product scraping site is designed to assist users in making informed decisions. It notifies users when a product drops in price and helps competitors by alerting them when the product is out of stock, all managed through cron jobs.
- Next.js
- Bright Data
- Cheerio
- Nodemailer
- MongoDB
- Headless UI
- Tailwind CSS
## 🔋 Features
👉 **Header with Carousel**: Visually appealing header with a carousel showcasing key features and benefits
👉 **Product Scraping**: A search bar allowing users to input Amazon product links for scraping.
👉 **Scraped Projects**: Displays the details of products scraped so far, offering insights into tracked items.
👉 **Scraped Product Details**: Showcase the product image, title, pricing, details, and other relevant information scraped from the original website
👉 **Track Option**: Modal for users to provide email addresses and opt-in for tracking.
👉 **Email Notifications**: Send emails product alert emails for various scenarios, e.g., back in stock alerts or lowest price notifications.
👉 **Automated Cron Jobs**: Utilize cron jobs to automate periodic scraping, ensuring data is up-to-date.
and many more, including code architecture and reusability
Follow these steps to set up the project locally on your machine.
**Prerequisites**
Make sure you have the following installed on your machine:
- [Git](https://git-scm.com/)
- [Node.js](https://nodejs.org/en)
- [npm](https://www.npmjs.com/) (Node Package Manager)
**Cloning the Repository**
```bash
git clone https://github.com/mdaashir/PriceTag.git
cd PriceTag
```
**Installation**
Install the project dependencies using npm:
```bash
npm install
```
**Set Up Environment Variables**
```
Copy the .env.sample file as .env and update with your credentials.
```
**Running the Project**
```bash
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) in your browser to view the project.
## 🔗 Links
Assets used in the project are [here](https://drive.google.com/file/d/1v6h993BgYX6axBoIXFbZ9HQAgqbR4PSH/view?usp=sharing)