diff --git a/apps/meowfacts/README.md b/apps/meowfacts/README.md new file mode 100644 index 00000000..bb3bbf31 --- /dev/null +++ b/apps/meowfacts/README.md @@ -0,0 +1,178 @@ +# 使用说明 +当第一次部署时，假如出现异常问题，如容器未找到等，解决方式如下： + +点击`已安装应用` > 找到应用 > 点`参数` > 点`编辑 `> 点`高级设置 `> 点击右下角`确认`。 + +采用的从源码编译镜像的方式，国内机子的话，假如因为各种网络原因，连接不上`github`， + +可以尝试修改`/opt/1panel/resource/apps/local/meowfacts/latest/Dockerfile` 里的`github`源码链接，用诸如`ghproxy`等。 + +# 原始相关 +meowfacts +========= + +[![Issues](https://img.shields.io/github/issues/wh-iterabb-it/meowfacts.svg)](https://github.com/wh-iterabb-it/meowfacts/issues) +[![License](https://img.shields.io/badge/license-GPL-blue.svg)](https://github.com/wh-iterabb-it/meowfacts/blob/main/LICENSE) +![Known Vulnerabilities](https://snyk.io/test/github/wh-iterabb-it/meowfacts/badge.svg) +[![codecov](https://codecov.io/gh/wh-iterabb-it/meowfacts/branch/main/graph/badge.svg)](https://codecov.io/gh/wh-iterabb-it/meowfacts) + + +## Description: + +A simple api that returns a random fact about cats on a GET request + +### Example Usage + +``` +curl https://meowfacts.herokuapp.com/ +``` + +Response + +```json +{ + "data": [ + "0": "Mother cats teach their kittens to use the litter box." + ] +} +``` + + +### Advanced Usage + +You can request more than one fact at a time by using the GET param `count` + +```bash +curl https://meowfacts.herokuapp.com/?count=3 +``` + +Response + +```json +{ + "data": [ + "0": "Mother cats teach their kittens to use the litter box.", + "1": "A cat can sprint at about thirty-one miles per hour.", + "2": "The worlds richest cat is worth $13 million after his human passed away and left her fortune to him." + ] +} +``` + +You can request a specific fact if you know the ID / order it is buy passing the GET param `id` + +```bash +curl https://meowfacts.herokuapp.com/?id=3 +``` + +Response + +```json +{ + "data": [ + "0": "Mother cats teach their kittens to use the litter box." + ] +} +``` + +### Language Support + +You can request the response in different languages by using the GET param `lang` + +```bash +curl https://meowfacts.herokuapp.com/?lang=ukr +``` + +Response + +```json +{ + "data": [ + "0": "Найбагатший у світі кіт коштує 13 мільйонів доларів після того, як його людина померла і залишила йому свій стан" + ] +} +``` + +#### Supported Languages + +The supported languages are listed below, you can use any of the `lang Values` in the first column as a `lang` param. + +"?lang=esp" and "?lang=esp-mx" will both return spanish for your response, and simply using the `ISO-639-1` code will default to esp-mx for simplicity. + +| LANG Variable | [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | Language Name | Localization (country) | +| :---: | :---: | :---: | :---: | +| `eng-us` | `eng` | English | USA | +| `ces-cz` or `cze-cz` | `cze` (B) `ces` (T) | Czech | CZ | +| `ger-de` | `ger` | German | DE | +| `esp-es` | `esp` | Spanish | ES | +| `esp-mx` | `esp` | Spanish (default) | MX | +| `rus-ru` | `rus` | Russian | RUS | +| `por-br` | `por` | Portuguese | BR | +| `tl-fil` | `fil` | Filipino | PH | +| `ukr-ua` | `ukr` | Ukrainian | UA | +| `urd-ur` | `urd` | Urdu | UR | +| `ita-it` | `ita` | Italian | IT | +| `zho-tw` | `zho` | Chinese | TW (Taiwan) | + + +
+ Help us expand and improve Internationalization on this API (Click to expand) +

Help us expand and improve Internationalization on this API

+ +

Note: We are trying to follow the browser's language tags, which are formally defined in RFC 5646, which rely on the ISO 639 standard (quite often the 639-1 code list) for language codes to be used.

+ +

We would love it if you helped this project by taking a look at our Call for Contributors to see if you can make a contribution that helps us be more inclusive and support more languages.

+
+ + +### Documentation + +
+

+ + + +

+

+ + + +

+

+ + + +

+
+ + +## Local Development + +### Installation + +``` +npm install +``` + +Basic usage + +``` +npm run start +``` + +### Dedication && Funding + + + + +
+

This api is dedicated to pistachio; she brought me great comfort in dire times. Words can't describe the debt I owe to her.

+ My cat, Sleeping on her back on a table, she did this everywhere because the fan would cool her belly. +

If you enjoy this api, or just love cats, please donate to:

+

NYC Animal Project Website

+

NYC Animal Project Paypal Link

+ +

NYC Animal Project is a struggling `no kill` cat shelter in the heart of new york that relies entirely on fosters and help from small donations. I can say personally having volunteered for them, even a few cents donation would make a difference for the very small organization. I fostered many kittens from them, and Pistachio was the runt that went un-adopted. She was shy, but very outgoing when she got settled. I highly recommend to foster and adopt if you can.

+ +
+ + diff --git a/apps/meowfacts/data.yml b/apps/meowfacts/data.yml new file mode 100644 index 00000000..729fe3dc --- /dev/null +++ b/apps/meowfacts/data.yml @@ -0,0 +1,20 @@ +name: meowfacts +tags: + - 工具 +title: 一个简单的 API，它返回一个 catfact +type: 工具 +description: 一个简单的 API，它返回一个 catfact +additionalProperties: + key: meowfacts + name: meowfacts + tags: + - Tool + shortDescZh: 一个简单的 API，它返回一个 catfact + shortDescEn: a simple api which returns a catfact + type: tool + crossVersionUpdate: true + limit: 0 + recommend: 0 + website: https://github.com/wh-iterabb-it/meowfacts + github: https://github.com/wh-iterabb-it/meowfacts + document: https://github.com/wh-iterabb-it/meowfacts diff --git a/apps/meowfacts/latest/.env.sample b/apps/meowfacts/latest/.env.sample new file mode 100644 index 00000000..6592fc0e --- /dev/null +++ b/apps/meowfacts/latest/.env.sample @@ -0,0 +1,2 @@ +CONTAINER_NAME="meowfacts" +PANEL_APP_PORT_HTTP="40045" diff --git a/apps/meowfacts/latest/Dockerfile b/apps/meowfacts/latest/Dockerfile new file mode 100644 index 00000000..df417e1f --- /dev/null +++ b/apps/meowfacts/latest/Dockerfile @@ -0,0 +1,19 @@ +FROM node:16-alpine + +# 安装 git，创建工作目录，并克隆代码 +RUN apk update && apk upgrade && \ + apk add --no-cache bash git openssh && \ + mkdir -p /usr/src/app && \ + git clone https://github.com/wh-iterabb-it/meowfacts /usr/src/app + +# 切换到工作目录 +WORKDIR /usr/src/app + +# 安装 Node.js 依赖 +RUN npm install + +# 暴露服务器端口 +EXPOSE 3000-5001 + +# 启动应用程序 +CMD ["npm", "start"] diff --git a/apps/meowfacts/latest/data.yml b/apps/meowfacts/latest/data.yml new file mode 100644 index 00000000..c1163d29 --- /dev/null +++ b/apps/meowfacts/latest/data.yml @@ -0,0 +1,10 @@ +additionalProperties: + formFields: + - default: 40045 + edit: true + envKey: PANEL_APP_PORT_HTTP + labelEn: Port + labelZh: 端口 + required: true + rule: paramPort + type: number \ No newline at end of file diff --git a/apps/meowfacts/latest/docker-compose.yml b/apps/meowfacts/latest/docker-compose.yml new file mode 100644 index 00000000..72356d2a --- /dev/null +++ b/apps/meowfacts/latest/docker-compose.yml @@ -0,0 +1,21 @@ +version: "3" +services: + meowfacts: + build: + context: . + dockerfile: Dockerfile + args: + IMAGE_TAG: latest + container_name: ${CONTAINER_NAME} + restart: always + networks: + - 1panel-network + ports: + - "${PANEL_APP_PORT_HTTP}:5000" + labels: + createdBy: "Apps" + +networks: + 1panel-network: + external: true + diff --git a/apps/meowfacts/logo.png b/apps/meowfacts/logo.png new file mode 100644 index 00000000..023fe72d Binary files /dev/null and b/apps/meowfacts/logo.png differ