ScrapQuest

[![Typing SVG](https://readme-typing-svg.herokuapp.com?font=Fira+Code&pause=1000&color=000000&random=false&width=660&lines=Solution+for+extracting+data+from+websites+effortlessly)](https://git.io/typing-svg)

⚡About Us:

ScrapQuest is your go-to solution for effortlessly extracting data from websites. It's a simple yet powerful web scraper built with Next.js, TypeScript, and Puppeteer with Browserless. With ScrapQuest, you can quickly gather valuable information from any website without hassle.

⚡short video for reference:

https://github.com/Abidsyed25/ScrapQuest/assets/116893970/7ee87ae2-b691-44de-8cd9-ead09fa985e7

Frontend Deployed here :- scrap-quest.vercel.app/

[!NOTE]
Due to some limitations, website functionality is limited on vercel. So setup project locally for complete functionality

Tech Stack

Next.js: A React framework for building server-side rendered and static web applications.
Puppeteer: A Node.js library for controlling headless Chrome or Chromium, used here for web scraping.
Browserless: A service that provides headless browser instances for Puppeteer.
TypeScript: A statically typed superset of JavaScript that adds type definitions for improved code quality and developer productivity.

⚡Setup locally

Follow these steps to set up ScrapQuest locally:

Prerequisites

Node.js (version 18) installed on your machine. You can download it here.

Steps

Using Docker

Fork the Repository
Clone your Fork from GitHub
```bash git clone https://github.com//ScrapQuest.git ```
```bash cd ScrapQuest ```
```bash docker-compose up ```

open localhost:3000 on the browser

Without Docker

Fork the Repository
Clone your Fork from GitHub
```bash git clone https://github.com//ScrapQuest.git ```
```bash cd ScrapQuest ```
```bash npm install ```
```bash npm run dev ```

open localhost:3000 on the browser

✍️ Open Source Contribution Welcome:

We welcome contributions from the community to improve ScrapQuest. Whether it's bug fixes, feature enhancements, or documentation improvements, your contributions are valuable.

:sparkles:Contribution Guidelines:

To submit your contributions, follow these steps: 1. **Fork the Repository**: Click the "Fork" button at the top right corner of the repository to create your own copy. 2. **Clone Your Fork**: Clone your forked repository to your local machine using the following command: ``` git clone https://github.com/Your-Username/ScrapQuest.git ``` 3. **Create a Branch**: Create a new branch for your changes: ``` git checkout -b my-feature ``` 4. **Make Changes**: Make your desired changes to the codebase. 5. **Commit Changes**: Commit your changes with a descriptive commit message: ``` git commit -m "Add new feature" ``` 6. **Push Changes**: Push your changes to your forked repository: ``` git push origin my-feature ``` 7. **Submit a Pull Request**: Go to your forked repository on GitHub and submit a pull request. Be sure to provide a detailed description of your changes and why they are necessary.

Code of Conduct:

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. And we appreciate your interest in contributing to ScrapQuest! Let's make it better together.

:zap: Featured In:

Open Source Programs

Event Logo	Event Name	Event Description
	GirlScript Summer of Code 2024	GirlScript Summer of Code is a three-month-long Open Source Program conducted every summer by GirlScript Foundation. It is an initiative to bring more beginners to Open-Source Software Development.