-
Notifications
You must be signed in to change notification settings - Fork 205
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add-README.md file in accordance with provided format
- Loading branch information
1 parent
361c717
commit da09af8
Showing
2 changed files
with
88 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,97 @@ | ||
## URL SCRAPPER | ||
- Uses Node.js, Express.js to scrap content of any url entered. | ||
- Eases the process of information extraction | ||
|
||
## HOW TO USE | ||
**Step1** | ||
<h1 align='center'><b>💥 PROJECT NAME 💥</b></h1> | ||
|
||
Run the project on your localhost using - | ||
<!-- -------------------------------------------------------------------------------------------------------------- --> | ||
|
||
<h3 align='center'>Tech Stack Used 🎮</h3> | ||
<!-- enlist all the technologies used to create this project from them (Remove co | ||
mment using 'ctrl+z' or 'command+z') --> | ||
|
||
<div align='center'> | ||
|
||
<!--  --> | ||
<!--  --> | ||
|
||
<!--  --> | ||
|
||
<!--  --> | ||
|
||
<!--  --> | ||
|
||
</div> | ||
|
||
 | ||
|
||
<!-- -------------------------------------------------------------------------------------------------------------- --> | ||
|
||
## :zap: Description 📃 | ||
|
||
<div> | ||
<h3>URL-Scraper:</h3> | ||
<p> | ||
<ul> | ||
<li>This project will be a Web Content Aggregator that collects and summarizes content of any website. | ||
<li>It will fetch the headings, sub headings, and further content of the website and display it in a visually appealing manner. | ||
<li>It can be used as a summarizer for the web page without actually going through the whole web page. | ||
</li> | ||
</li> | ||
</li> | ||
</ul></p> | ||
</div> | ||
|
||
<!-- -------------------------------------------------------------------------------------------------------------- --> | ||
|
||
## :zap: How to run it? 🕹️ | ||
|
||
To run the application follow these steps: | ||
|
||
**Step 1:** Fork the repository. Follow these guidelines to know all about how to fork a repository | ||
[Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) | ||
|
||
**Step 2:** Clone the repository. [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request) | ||
|
||
**Step 3:** Go to Url-Scrapper folder and run | ||
|
||
`npm install` | ||
|
||
`npm run` | ||
`npm run dev` | ||
|
||
**Step 4:** Go to `http://localhost:8001` and enter url of the webpage you want to access contents of | ||
|
||
## Voila! Have fun using the site. | ||
|
||
<!-- -------------------------------------------------------------------------------------------------------------- --> | ||
|
||
## :zap: Screenshots 📸 | ||
|
||
- Web page user interface | ||
 | ||
- Input type | ||
 | ||
- Scraped information | ||
 | ||
- When in case of invalid input | ||
 | ||
- Error message gets displayed for invalid URL | ||
 | ||
- When in case of an unsafe site | ||
 | ||
- Error is displayed for the invalid site | ||
 | ||
|
||
**Step 2** | ||
 | ||
|
||
Go to `http://localhost:8000` in your preferred browser. | ||
<!-- -------------------------------------------------------------------------------------------------------------- --> | ||
|
||
**Step 3** | ||
<h4 align='center'>Developed By <b><i>RAGINI MISHRA</i></b> 👦</h4> | ||
<p align='center'> | ||
<a href='https://www.linkedin.com/in/ragini-mishra-5a78b3217/'> | ||
<img src='https://img.shields.io/badge/linkedin-%230077B5.svg?style=for-the-badge&logo=linkedin&logoColor=white' /> | ||
</a> | ||
<a href='https://github.com/Rags-Mishra'> | ||
<img src='https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white' /> | ||
</a> | ||
</p> | ||
|
||
Enter the url of your choice and hit `scrape` and voila! All the contents of the site is displayed on your screen. | ||
<h4 align='center'>Happy Coding 🧑💻</h4> | ||
|
||
<h3 align="center">Show some ❤️ by 🌟 this repository!</h3> |
Binary file not shown.