Skip to content

Clone xkcd to browse and search offline

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

Flakebi/offline-xkcd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Offline xkcd

Ever wanted to show a friend a xkcd comic but you were offline?
This application provides a local xkcd clone which is even searchable.

Usage

  1. Install and enable the nightly rust toolchain (preferred installation method is rustup)
  2. (optional) Execute the cargo run ... commands with cargo run --release ...
  3. Clone the current xkcd data (execute this command whenever you want to update the data)
    cargo run -- update
  4. Start the local server
    cargo run -- server
  5. Browse xkcd at localhost:8080 and have fun

Configuration

All configuration options can also be found with cargo run -- help and cargo run -- help <subcommand>.

  • While downloading xkcd, you can specify the number of concurrent connections with cargo run -- update -j <num> (default is 4)
  • Set the server port with -p <port> (default is 8080)
  • Set the listening address with -a <address> (default is 0.0.0.0)

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

About

Clone xkcd to browse and search offline

Topics

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published