Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Page-Replica/page-replica
Page Replica – Tool for Web Scraping, Prerendering, and SEO Boost
https://github.com/Page-Replica/page-replica
caching frontend prerendering seo-optimization ssr
Last synced: about 2 months ago
JSON representation
Page Replica – Tool for Web Scraping, Prerendering, and SEO Boost
- Host: GitHub
- URL: https://github.com/Page-Replica/page-replica
- Owner: Page-Replica
- License: mit
- Created: 2023-12-31T22:23:04.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-22T04:37:41.000Z (6 months ago)
- Last Synced: 2024-11-29T12:37:26.837Z (about 2 months ago)
- Topics: caching, frontend, prerendering, seo-optimization, ssr
- Language: JavaScript
- Homepage: https://page-replica.com
- Size: 13.7 KB
- Stars: 425
- Watchers: 4
- Forks: 18
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Good news everyone! Page Replica is Available as a Web App!
If you want to avoid the hassle of setting up your own pre-rendering tool, check out [Page Replica](https://page-replica.com). Manage and re-render your pages effortlessly!
### Key Feature
- Page Replica is free to use for up to 5,000 requests per month.
- Unlimited sites
- API access
### Need Assistance?
If you have any questions or need support, we're here to help! Join our [GitHub Discussion](https://github.com/html5-ninja/page-replica/discussions/3) to get in touch with us.
---
# Page Replica free tool
"Page Replica" is a versatile web scraping and caching tool built with Node.js, Express, and Puppeteer. It helps prerender web app (React, Angular, Vue,...) pages, which can be served via Nginx for SEO or other purposes.
The tool allows you to scrape individual web pages or entire sitemaps trough an api, selectively removing JavaScript, and caching the resulting HTML.
Additionally, it features an Nginx configuration that optimally handles user and search engine bot traffic.
## Installation
1. **Clone the Repository:**
```bash
git clone https://github.com/html5-ninja/page-replica.git
cd page-replica
```
2. **Install Dependencies:**
```bash
npm install
```
3. **Settings:**
- index.js
```bash
const CONFIG = {
baseUrl: "https://example.com",
removeJS: true,
addBaseURL: true,
cacheFolder: "path_to_cache_folder",
}
```
- app.js : set the port for your API
4. **Start the API:**
```bash
npm start
```
## Usage
By scraping a page or a sitemap, a copy of the prerendered page will be stored in the cache folder.
### Scraping Individual Pages
To scrape a single page, make a GET request to `/page` with the `url` query parameter:
```bash
curl http://localhost:8080/page?url=https://example.com
```
### Scraping Sitemaps
To scrape pages from a sitemap, make a GET request to `/sitemap` with the `url` query parameter:
```bash
curl http://localhost:8080/sitemap?url=https://example.com/sitemap.xml
```
## Serve the Cached Pages to Bots with Nginx (My Recipe)
In this case, the cached pages are served using Nginx. You can adapt this configuration to your needs and your server.
The Nginx configuration, residing in `nginx_config_sample/example.com.conf`, thoughtfully manages traffic.
It efficiently routes regular users to the main application server and redirects search engine bots to a dedicated server block for cached HTML delivery.
Please review the `nginx_config_sample/example.com.conf` file to gain an understanding of its functionality.
## Contribution
We welcome contributions! If you have ideas for new features or server/cloud configurations that could enhance this tool, feel free to:
- Open an issue to discuss your ideas.
- Fork the repository and make your changes.
- Submit a pull request with a clear description of your changes.
### Feature Requests and Suggestions
If you have any feature requests or suggestions for server/cloud configurations beyond Nginx, please open an issue to start a discussion.
## Folder Structure
- `nginx_config_sample`: Presents a sample Nginx configuration for redirecting bot traffic to the cached content server.
- `api.js`: An Express application responsible for handling web scraping requests.
- `index.js`: The core web scraping logic employing Puppeteer.
- `package.json`: Node.js project configuration.