https://github.com/lmt-swallow/puppy-browser

An example implementation of a tiny Web browser for educational purposes.
https://github.com/lmt-swallow/puppy-browser

browser education rust web

Last synced: 3 months ago
JSON representation

An example implementation of a tiny Web browser for educational purposes.

• Host: GitHub
• URL: https://github.com/lmt-swallow/puppy-browser
• Owner: lmt-swallow
• License: mit
• Created: 2021-04-29T06:42:36.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-09-11T14:38:45.000Z (over 2 years ago)
• Last Synced: 2024-08-01T22:53:40.420Z (6 months ago)
• Topics: browser, education, rust, web
• Language: Rust
• Homepage:
• Size: 184 KB
• Stars: 634
• Watchers: 8
• Forks: 24
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-star - puppy-browser - swallow | 607 | (Rust)

README

        
# puppy

[![Run tests](https://github.com/lmt-swallow/puppy/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/lmt-swallow/puppy/actions/workflows/test.yml) [![Run lint](https://github.com/lmt-swallow/puppy/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/lmt-swallow/puppy/actions/workflows/lint.yml)

`puppy` is an example implementation of a tiny Web browser for educational purposes.

![puppy-browser](./docs/images/puppy-browser.png)

## How to run puppy locally

You can run puppy program with the following command(s):

```sh

cargo run -- help

```

## How to install puppy

You can install puppy by the following command(s):

```sh

cargo install --locked --path . --force

```

After you have successfully installed puppy, you can see help as follows:

```sh

puppy help

```

You can install shell completions as follows:

```sh

# in bash

eval "$(puppy completion bash)"

# in fish

puppy completion fish | source

```

## How to run tests locally

You can run tests with the following command(s):

```sh

cargo test

```

## How to speed up build process

You can cache files related to V8 as follows:

```bash

$ export RUSTY_V8_MIRROR=$HOME/.cache/rusty_v8

(...omitted...)

$ ./scripts/prepare-v8.sh

(...omitted...)

$ cargo build

(...omitted...)

```