GarbageReminder/Docs
1
0
Fork 0
Code Issues Pull Requests Actions Releases Wiki Activity

Added start and deployment pages
All checks were successful
Tests / test (3.10) (push) Successful in 12s
Details
Tests / test (3.11) (push) Successful in 10s
Details
Tests / test (3.9) (push) Successful in 10s
Details

Browse Source
This commit is contained in:
Profitroll
2024-05-24 22:26:44 +02:00
parent 81d2701ee1
commit 5a1dd347d0
4 changed files with 33 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/deployment.md Normal file
View File

@@ -0,0 +1,11 @@
# Deployment
Bare minimum installation requires a database and an API. Then you can use any way you like to connect to the API.
We provide Telegram bot and raw HTTP for that now, but Discord bot and CLI are planned too.
Here is how the "normal" deployment process looks like:
1. Install the requirements [[API](api/installation.md#requirements)/[Telegram](bot_telegram/installation.md#requirements)]
2. Install the API server [[Guide](api/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)]

12
docs/index.md
View File

@@ -13,15 +13,3 @@ We provide chatbots as clients. These bots provide the access to the data stored
After seeing that most cities and villages around only offer proprietary software/websites or even no digital information
about garbage collection at all, it was decided to develop an own solution to this problem by storing the data in a
database and then show the data the way it is helpful for the end-user.
## Deployment
Bare minimum installation requires a database and an API. Then you can use any way you like to connect to the API.
We provide Telegram bot and raw HTTP for that now, but Discord bot and CLI are planned too.
Here is how the "normal" deployment process looks like:
1. Install the requirements [[API](api/installation.md#requirements)/[Telegram](bot_telegram/installation.md#requirements)]
2. Install the API server [[Guide](api/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)]

17
docs/start-using.md Normal file
View File

@@ -0,0 +1,17 @@
# Start using
There are two common usage scenarios: using public instance and deploying your own.
## Using public instance
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 Telegram Bot](https://t.me/GarbageReminder_Bot)
You can find out more about public instance in the [Public instance](community/public/index.md) section.
## Deploying own instance
For more personalized experience, you can deploy your own API and clients wherever you want to.
Follow the [deployment guide](deployment.md) for detailed instructions.