/flipkart-scraper-api

A RESTful API that scrapes Flipkart data built using TypeScript, Node.js, ExpressJS secured with JWT, stored in MongoDB, deployed on AWS for live access.

Primary LanguageTypeScript

Flipkart Scraper API

Postman documentation

Tech Stack

  • Typescript
  • Node.js
  • ExpressJS
  • JWT
  • MongoDB + Mongoose
  • AWS

Deployed to AWS (Live endpoint)

Endpoints

endpoints

System Design

system-design

Steps to run locally

  • Clone this repo

    git clone https://github.com/rahulsm20/flipkart-scraper-api.git

  • Enter folder

    cd flipkart-scraper-api

  • Install packages

    npm install

  • Add a connection URL to a MongoDB instance in a .env file at the root of the directory and a 256-bit JWT secret key

    • Example 
      MONGO_URL=mongodb+srv://admin:<password>@cluster0.5kaqvs5.mongodb.net/<collection_name>
JWT_SECRET=<INSERT_SECRET>

  • Run project

    • Dev mode 
      npm run dev
    • Production mode 
      npm start