An open API service indexing awesome lists of open source software.

https://github.com/rahulsm20/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.
https://github.com/rahulsm20/flipkart-scraper-api

aws-lambda docker express jwt mongodb mongoose node rest-api typescript

Last synced: 2 months ago
JSON representation

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.

Awesome Lists containing this project

README

          

# Flipkart Scraper API
[Postman documentation](https://documenter.getpostman.com/view/22495929/2s9Xy5NWqv)

### Tech Stack
* Typescript
* Node.js
* ExpressJS
* JWT
* MongoDB + Mongoose
* AWS

Deployed to AWS ([Live endpoint](https://xopepr7x6d.execute-api.ap-south-1.amazonaws.com/dev/))

### Endpoints
![endpoints](https://github.com/rahulsm20/flipkart-scraper-api/assets/77540672/4ce21770-a257-4a0b-9006-d5d9759d26fb)

### System Design
![system-design](https://github.com/rahulsm20/flipkart-scraper-api/assets/77540672/cc550f3a-9928-4b19-abd9-49f36e2dade6)

### 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:@cluster0.5kaqvs5.mongodb.net/
JWT_SECRET=
```
* Run project
* Dev mode
```
npm run dev
```
* Production mode
```
npm start
```