Compare commits
6 Commits
5a1dd347d0
...
main
Author | SHA1 | Date | |
---|---|---|---|
f5490bd96a | |||
1c82c800e9 | |||
d4e8522687
|
|||
42d6eb312b
|
|||
fc18deadf6 | |||
45bd718a1c |
@@ -11,8 +11,7 @@ on:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
test:
|
test:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-24.04
|
||||||
container: catthehacker/ubuntu:act-latest
|
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
python-version: ["3.9", "3.10", "3.11"]
|
python-version: ["3.9", "3.10", "3.11"]
|
||||||
@@ -23,6 +22,7 @@ jobs:
|
|||||||
uses: actions/setup-python@v3
|
uses: actions/setup-python@v3
|
||||||
with:
|
with:
|
||||||
python-version: ${{ matrix.python-version }}
|
python-version: ${{ matrix.python-version }}
|
||||||
|
cache: 'pip'
|
||||||
env:
|
env:
|
||||||
AGENT_TOOLSDIRECTORY: /opt/hostedtoolcache
|
AGENT_TOOLSDIRECTORY: /opt/hostedtoolcache
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
|
@@ -1,3 +1,29 @@
|
|||||||
# Public instance
|
# Public instance
|
||||||
|
|
||||||
This section is under construction.
|
There is a publicly available hosted version of the API and all clients.
|
||||||
|
|
||||||
|
## When to use public instance
|
||||||
|
|
||||||
|
You should use public instance if:
|
||||||
|
|
||||||
|
* You need garbage reminders for [Gemeinde Schmitten](https://www.schmitten.de){:target="_blank"}
|
||||||
|
* You need a stable bot and API versions with good uptime
|
||||||
|
* You want to contribute [locations](locations.md) and/or [entries](entries.md)
|
||||||
|
* You need community and developer [support](report.md)
|
||||||
|
|
||||||
|
You should **NOT** use public instance if:
|
||||||
|
|
||||||
|
* You want to modify the source code
|
||||||
|
* You have non-standard garbage types
|
||||||
|
* You want to add non-standardized locations
|
||||||
|
|
||||||
|
## Start using it
|
||||||
|
|
||||||
|
### API
|
||||||
|
|
||||||
|
* Endpoint: <https://api.garbagebot.eu>{:target="_blank"}
|
||||||
|
* Docs: [Swagger](https://api.garbagebot.eu/docs){:target="_blank"} / [Redoc](https://api.garbagebot.eu/redoc){:target="_blank"}
|
||||||
|
|
||||||
|
### Telegram Bot
|
||||||
|
|
||||||
|
* Link: <https://t.me/GarbageReminder_Bot>{:target="_blank"}
|
||||||
|
@@ -6,6 +6,6 @@ We provide Telegram bot and raw HTTP for that now, but Discord bot and CLI are p
|
|||||||
Here is how the "normal" deployment process looks like:
|
Here is how the "normal" deployment process looks like:
|
||||||
|
|
||||||
1. Install the requirements [[API](api/installation.md#requirements)/[Telegram](bot_telegram/installation.md#requirements)]
|
1. Install the requirements [[API](api/installation.md#requirements)/[Telegram](bot_telegram/installation.md#requirements)]
|
||||||
2. Install the API server [[Guide](api/installation.md)]
|
2. Install the API server [[Guide](api/installation.md/#installation-process)]
|
||||||
3. Install the client/bot of your linking [[Telegram](bot_telegram/installation.md)]
|
3. Install the client/bot of your linking [[Telegram](bot_telegram/installation.md)]
|
||||||
4. Fill the API/bot with the data [[API](api/feeding-data.md)/[Telegram](bot_telegram/feeding-data.md)]
|
4. Fill the API/bot with the data [[API](api/feeding-data.md)/[Telegram](bot_telegram/feeding-data.md)]
|
||||||
|
@@ -6,8 +6,8 @@ There are two common usage scenarios: using public instance and deploying your o
|
|||||||
|
|
||||||
While limited in coverage, public instance offers the access to the latest stable version of the API and chat-bots.
|
While limited in coverage, public instance offers the access to the latest stable version of the API and chat-bots.
|
||||||
|
|
||||||
* [Public API](https://api.garbagebot.eu)
|
* [Public API](https://api.garbagebot.eu/redoc){:target="_blank"}
|
||||||
* [Public Telegram Bot](https://t.me/GarbageReminder_Bot)
|
* [Public Telegram Bot](https://t.me/GarbageReminder_Bot){:target="_blank"}
|
||||||
|
|
||||||
You can find out more about public instance in the [Public instance](community/public/index.md) section.
|
You can find out more about public instance in the [Public instance](community/public/index.md) section.
|
||||||
|
|
||||||
|
@@ -101,6 +101,7 @@ theme:
|
|||||||
icon:
|
icon:
|
||||||
logo: logo
|
logo: logo
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
|
- attr_list
|
||||||
- pymdownx.details
|
- pymdownx.details
|
||||||
- pymdownx.superfences
|
- pymdownx.superfences
|
||||||
- pymdownx.tabbed:
|
- pymdownx.tabbed:
|
||||||
|
Reference in New Issue
Block a user