Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yunohost-apps/peppermint_ynh

Peppermint package for YunoHost
https://github.com/yunohost-apps/peppermint_ynh

peppermint yunohost yunohost-apps

Last synced: 3 days ago
JSON representation

Peppermint package for YunoHost

Host: GitHub
URL: https://github.com/yunohost-apps/peppermint_ynh
Owner: YunoHost-Apps
License: gpl-3.0
Created: 2023-08-01T18:07:50.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2023-11-11T22:46:31.000Z (about 1 year ago)
Last Synced: 2024-11-17T03:28:17.807Z (2 months ago)
Topics: peppermint, yunohost, yunohost-apps
Language: Shell
Homepage:
Size: 95.7 KB
Stars: 0
Watchers: 4
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Packaging an app, starting from this example

* Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
* Edit the `manifest.json` with app specific info.
* Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.
* Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
* Add a `LICENSE` file for the package.
* Edit `doc/DISCLAIMER*.md`
* The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator

---

# Example app for YunoHost

[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Working status](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg)

[![Install Example app with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install Example app 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

This is a dummy description of this app features

**Shipped version:** 1.0~ynh1

**Demo:** https://demo.example.com

## Screenshots

![Screenshot of Example app](./doc/screenshots/example.jpg)

## Documentation and resources

* Official app website:
* Official user documentation:
* Official admin documentation:
* Upstream app code repository:
* YunoHost documentation for this app:
* Report a bug:

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing).

To try the testing branch, please proceed like that.

``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
or
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
```

**More info regarding app packaging:**