Skip to content

Commit ed39cfd

Browse files
committed
Update readme.md file
1 parent eba5acb commit ed39cfd

File tree

1 file changed

+32
-20
lines changed

1 file changed

+32
-20
lines changed

README.md

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# React Node Web Scraper
22

3-
This project is a web scraper that consists of a client and a server. The client was bootstrapped with Create React App, and the server uses Express.js, Axios, Cheerio, and Puppeteer for web scraping.
3+
## Overview
4+
5+
This project is a web scraper that consists of a client and a server. The client is a [React](https://react.dev/) app bootstrapped with [vite](https://vitejs.dev/) and the server uses Express.js, Axios, Cheerio, and Puppeteer for web scraping.
46

57
## Project Structure
68

@@ -9,42 +11,52 @@ The project has two main folders:
911
- `client`: This is where the front-end code resides.
1012
- `server`: This contains the back-end code for the web scraper.
1113

12-
## Server
14+
## Technologies Used
1315

14-
The server is an Express.js application that uses Axios for making HTTP requests, Cheerio for parsing HTML, and Puppeteer for browser automation.
16+
- **Frontend**: React, Vite
17+
- **Backend**: Node.js, Express, Axios, Cheerio, Puppeteer
1518

16-
### Install Dependencies
19+
## Getting Started
1720

18-
#### `npm install`
21+
### Prerequisites
1922

20-
### Available Scripts
23+
- Node.js (v14 or later)
24+
- npm or yarn
2125

22-
In the server directory, you can run:
26+
### Installation
2327

24-
#### `npm start`
28+
1. Clone the repository:
2529

26-
Runs the server in development mode with nodemon.
30+
```bash
31+
git clone https://github.com/yourusername/react-node-web-scraper.git
32+
cd react-node-web-scraper
33+
```
2734

28-
## Client
35+
2. Install dependencies for both server and client applications using:
36+
```bash
37+
npm install
38+
# or
39+
yarn
40+
```
2941

30-
This is a [React App](https://react.dev/) bootstrapped with [vite](https://vitejs.dev/).
42+
### Running the Application
3143

32-
## Getting Started
44+
## Server
3345

34-
For Running the client app:
46+
### Available Scripts
3547

36-
Steps to follows:
48+
In the server directory, you can run:
3749

38-
install Dependencies:
50+
#### `npm start`
3951

40-
```bash
41-
npm install
42-
# or
43-
yarn
44-
```
52+
Runs the server in development mode with nodemon. Open http://localhost:8000 to view the response from `/` endpoint in the browser or any other api client.
53+
54+
## Client
4555

4656
### Available Scripts:
4757

58+
In the client directory, you can run:
59+
4860
```bash
4961
npm run dev
5062
# or

0 commit comments

Comments
 (0)