Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matteocontrini/locuspocusbot
Telegram bot for finding free and occupied rooms in UniTN buildings
https://github.com/matteocontrini/locuspocusbot
bot dotnet-core telegram unitn
Last synced: 2 days ago
JSON representation
Telegram bot for finding free and occupied rooms in UniTN buildings
- Host: GitHub
- URL: https://github.com/matteocontrini/locuspocusbot
- Owner: matteocontrini
- License: mit
- Created: 2017-10-14T16:09:35.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2023-10-25T17:00:06.000Z (about 1 year ago)
- Last Synced: 2024-08-02T14:05:02.078Z (3 months ago)
- Topics: bot, dotnet-core, telegram, unitn
- Language: C#
- Homepage: https://t.me/LocusPocusBot
- Size: 2.04 MB
- Stars: 11
- Watchers: 6
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LocusPocusBot 2.0 [](https://travis-ci.com/matteocontrini/locuspocusbot)
## Previous versions
A previous version of this bot was developed in Go and has been available for about a year and a half. The code of that version is now available [in another branch](https://github.com/matteocontrini/locuspocusbot/tree/go).
## Requirements
MongoDB is required for the bot to work. Data about users and groups will be stored in the database.
## Configuration
Configuration of the application is done through the `appsettings.json` file read from the current working directory at startup.
Examples for [development](https://github.com/matteocontrini/locuspocusbot/blob/dotnet/LocusPocusBot/appsettings.example.development.json) and [production](https://github.com/matteocontrini/locuspocusbot/blob/dotnet/LocusPocusBot/appsettings.example.json) environments are available.
## Running for development
Choose one of the following methods:
### Visual Studio
Requirements:
- .NET 6.0 SDK is installed
- MongoDB is running on the host and port specified in the `appsettings.json` file
- The `LocusPocusBot/bin/Debug/net6.0` directory contains the `appsettings.json` file
Run with the nice green button.
### dotnet CLI
Requirements:
- .NET 6.0 SDK is installed
- MongoDB is running on the host and port specified in the `appsettings.json` file
- The `LocusPocusBot` directory contains the `appsettings.json` file
Run with the dotnet CLI by executing:
```sh
cd LocusPocusBot
dotnet run
```
### Docker Compose
A basic development Docker Compose file (not including MongoDB) would look like this:
```yaml
version: '3'
services:
locuspocusbot:
container_name: 'locuspocusbot'
build: .
network_mode: 'host'
volumes:
- ./LocusPocusBot/appsettings.json:/app/appsettings.json
```
This time make sure that the configuration file lies at `LocusPocusBot/appsettings.json`.
Now run this command in the repository directory:
```sh
docker-compose -f docker-compose.yml up --build
```
## Running in production
A basic Docker Compose file for production looks like this:
```yaml
version: '3'
services:
locuspocusbot:
container_name: 'locuspocusbot'
image: 'matteocontrini/locuspocusbot'
restart: unless-stopped
network_mode: 'host'
volumes:
- ./appsettings.json:/app/appsettings.json
```