mirror of
https://github.com/YunoHost-Apps/jump_ynh.git
synced 2024-09-03 20:36:28 +02:00
57 lines
2.4 KiB
Markdown
57 lines
2.4 KiB
Markdown
<!--
|
|
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
|
It shall NOT be edited by hand.
|
|
-->
|
|
|
|
# Jump for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/jump)  
|
|
|
|
[](https://install-app.yunohost.org/?app=jump)
|
|
|
|
*[Read this README in other languages.](./ALL_README.md)*
|
|
|
|
> *This package allows you to install Jump quickly and simply on a YunoHost server.*
|
|
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
|
|
|
|
## Overview
|
|
|
|
# Jump
|
|
Jump is a self-hosted startpage and real-time status page for your server designed to be simple, stylish, fast and secure.
|
|
### Features
|
|
|
|
- Fast, easy to deploy, secure.
|
|
- Easily add sites and use custom icons, or let Jump fetch their original favicons.
|
|
- Categorise sites with tags across multiple pages.
|
|
- Real-time status monitoring for each site.
|
|
- Use your own background images or get random background images from Unsplash.
|
|
- Fast search by name, tag, url with keyboard shortcut.
|
|
- Custom list of search engines accessed via search box.
|
|
- Open Weather Map integration for local time and weather.
|
|
- Several layout options, including responsive UI for mobile devices.
|
|
- Easily enable/disable all configuration options, tailor Jump to suit your needs.
|
|
|
|
|
|
**Shipped version:** 1.3.2~ynh1
|
|
|
|
**Demo:** <https://jumpdemo.daledavies.co.uk/>
|
|
## Documentation and resources
|
|
|
|
- Official user documentation: <https://github.com/daledavies/jump/blob/main/README.md>
|
|
- Upstream app code repository: <https://github.com/daledavies/jump/tree/main>
|
|
- YunoHost Store: <https://apps.yunohost.org/app/jump>
|
|
- Report a bug: <https://github.com/YunoHost-Apps/jump_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/jump_ynh/tree/testing).
|
|
|
|
To try the `testing` branch, please proceed like that:
|
|
|
|
```bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/jump_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade jump -u https://github.com/YunoHost-Apps/jump_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|