Skip to content
This repository has been archived by the owner on Mar 19, 2024. It is now read-only.

Commit

Permalink
docs: 📝 Update readme #3
Browse files Browse the repository at this point in the history
  • Loading branch information
Kalhama committed Apr 5, 2023
1 parent 1b79f4d commit 970b64d
Showing 1 changed file with 25 additions and 7 deletions.
32 changes: 25 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,29 @@
# jstrack
Alternative for httrack
## Introduction ##
JSTrack is CLI tool for serving mirrors including dynamically loaded content.

## Server ##
- matching based on url path, request method
JSTrack shares similar goals with popular applications `wget` and `httrack` but takes a step further by preserving also dynamically loaded content that is not included in the original page load.

# Contribute #
This project follows [semver] and [conventional commits]
This type of content is becoming more and more dominant with client side rendering is becoming more popular.

# Bugs, feature requests etc... #
[Github issues](https://github.com/Kalhama/jstrack/issues)
## Installation ##
1. [Install rust](https://rustup.rs/)
2. Run `cargo install --git https://github.com/Kalhama/jstrack.git`
- please mind that the software is still in under contruction and api is excepted to break
3. Run `jstrack --help`

## Usage ##
1. Get HAR (HTTP ARchive) of website(s) you want to backup
- [Tutorial from microsoft](https://learn.microsoft.com/en-us/azure/azure-portal/capture-browser-trace) on how to get har file
- This tool cannot (yet) generate HAR file [Discussion #16](https://github.com/Kalhama/jstrack/discussions/16)
2. Run `jstrack website.har`
3. Navigate to http://127.0.0.1:8080 on yoor browser to view the mirror
- TODO load content through mirror by default [#1](https://github.com/Kalhama/jstrack/issues/1) and [#2](https://github.com/Kalhama/jstrack/issues/2)

## Features ##
- Serve mirror of webpage with dynamic content from HAR file

## Contributing & support ##
This project follows [semver] and [conventional commits].

Pull requests, bug reports, questions and feature requests: [Github issues](https://github.com/Kalhama/jstrack/issues)

0 comments on commit 970b64d

Please sign in to comment.