Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 24 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,46 @@
# IPI GitHub Pages Preview

Legacy Vue application used to preview IPI web concepts on GitHub Pages.
Legacy Vue/Vite scaffold retained to preserve the history of an earlier IPI
GitHub Pages experiment. The maintained website and documentation source is
[`www.ipi.io`](https://github.com/ipicoin/www.ipi.io).

> **Status: incubating and non-canonical.** The maintained public website source
> is [`www.ipi.io`](https://github.com/ipicoin/www.ipi.io). Content here must not
> be treated as a protocol specification, current network status, or official
> production release unless the canonical project documentation links to it.
## What the source contains

## Development
The current default branch is essentially the generated Vue starter:

- Home and About routes;
- the placeholder counter store and starter styles;
- one generated Playwright check for the starter heading; and
- Vite, linting, formatting, and GitHub Pages workflow configuration.

It does not implement a wallet, explorer, protocol client, or current IPI
product experience. There are no unit test files even though a `test:unit`
script remains in `package.json`.

Requires Node.js `20.19` or newer, or `22.12` or newer.
## Development

```sh
npm install
npm run dev
npm run build
npm run test:unit
npm run lint
```

End-to-end tests use Playwright:
The Vite production build succeeds. The generated end-to-end check can be run
with Playwright after installing its browser dependencies:

```sh
npx playwright install
npm run build
npm run test:e2e
```

## Development status

**Legacy scaffold.** This repository is non-canonical and should not be used as
evidence of current IPI functionality, protocol status, or a production release.
New website and documentation work belongs in
[`www.ipi.io`](https://github.com/ipicoin/www.ipi.io).

## License

Licensed under [Apache License 2.0](LICENSE).
64 changes: 35 additions & 29 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.