2023-11-07 11:33:25 +01:00
# xrsh
2023-11-01 11:21:41 +01:00
2023-11-03 11:01:42 +01:00
< img src = 'src/assets/logo.svg' width = "25%" / >
2023-11-01 11:21:41 +01:00
2024-01-08 20:32:27 +00:00
## Wiki / Roadmap
2023-12-11 19:42:51 +01:00
See [the wiki here ](https://forgejo.isvery.ninja/xrsh/xrsh/wiki/Home#milestones )
2024-01-08 20:32:27 +00:00
## Install
2023-11-01 11:21:41 +01:00
2024-05-22 08:23:56 +00:00
> NOTE: installation not needed, just surf to the public version [here](https://coderofsalvation.github.io/xrsh)
1. Download [xrsh.com ](https://forgejo.isvery.ninja/xrsh/xrsh/raw/branch/main/xrsh.com )
2024-05-22 08:50:38 +00:00
2. optional: run `unzip xrsh.com` to verify repository contents
3. run `chmod +x xrsh.com` in your console
2024-10-28 14:40:32 +00:00
4. run `./xrsh.com`
5. Profit! ✔
The browser auto-launches `https://localhost:8080` on most platforms
> pass `-p XXXX` to specify port (default:8080)
< details >
< summary > Nix-users< / summary >
1. run `nix-run -p xrsh --run "xrsh.com"` (pass `-p XXXX` to specify non-default 8080 port )
2. build it when package does not exist: `nix-build -E "with import <nixpkgs> { }; callPackage ./xrsh.nix"`
< / details >
2023-11-01 11:21:41 +01:00
2024-01-08 20:32:27 +00:00
## Developers
2024-05-30 14:44:41 +00:00
Make sure to clone the repo including submodules (the [xrsh-com ](https://forgejo.isvery.ninja/xrsh/xrsh-com ) repo)
2024-05-22 08:23:56 +00:00
2024-01-08 20:32:27 +00:00
```
2024-07-23 13:22:13 +00:00
$ git clone --recurse-submodules https://forgejo.isvery.ninja/xrsh/xrsh
2024-01-08 20:32:27 +00:00
```
2024-05-22 08:23:56 +00:00
> Now serve the repo from a HTTPS webserver (for example run `./make dev`)
2024-01-08 13:44:05 +00:00
2024-08-29 15:39:54 +00:00
Run `./make standalone` to package everything into `xrsh.com`
2024-10-04 16:01:37 +00:00
2024-09-13 17:00:18 +02:00
## Funding
This project is funded through [NGI0 Entrust ](https://nlnet.nl/entrust ), a fund established by [NLnet ](https://nlnet.nl ) with financial support from the European Commission's [Next Generation Internet ](https://ngi.eu ) program. Learn more at the [NLnet project page ](https://nlnet.nl/project/xrsh ).
[<img src="https://nlnet.nl/logo/banner.png" alt="NLnet foundation logo" width="20%" /> ](https://nlnet.nl )
[<img src="https://nlnet.nl/image/logos/NGI0_tag.svg" alt="NGI Zero Logo" width="20%" /> ](https://nlnet.nl/entrust )
