Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xxgicoxx/steamgram-bot
Telegram bot for Steam friends notifications.
https://github.com/xxgicoxx/steamgram-bot
friends notification steam steamgram
Last synced: 20 days ago
JSON representation
Telegram bot for Steam friends notifications.
- Host: GitHub
- URL: https://github.com/xxgicoxx/steamgram-bot
- Owner: xxgicoxx
- License: mit
- Created: 2020-01-28T01:18:28.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-25T04:34:52.000Z (almost 2 years ago)
- Last Synced: 2024-12-30T19:37:00.646Z (24 days ago)
- Topics: friends, notification, steam, steamgram
- Language: JavaScript
- Size: 89.8 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Steamgram
Telegram bot for Steam friends notifications.
# Features
* /search `App ID` or `Name` - Search App
* /add `Steam ID` - Add Steam ID
* /remove `Steam ID` - Remove Steam ID
* /list - List players
* /help - Help
# Prerequisites
* [Node.js](https://nodejs.org/en/)
# Running
### 1. Configure
````
# Bot
Create and configure .env file like .env.example.
````
### 2. Telegram
````
# Create an Telegram bot
Find @BotFather on Telegram, type /newbot and follow the instructions.
# Username
Get your bot username and set 'TELEGRAM_USERNAME' in .env.
# Token
Get your token from @BotFather and set 'TELEGRAM_TOKEN' in .env.
````
### 3. Steam
````
# Configure
Get your key from https://steamcommunity.com/dev/apikey and set in .env.
````
### 4. PostgreSQL
````
# Install
Install PostgreSQL and create an database.
# Configure
Set PostgreSQL 'POSTGRESQL_USERNAME', 'POSTGRESQL_PASSWORD', 'POSTGRESQL_DATABASE', 'POSTGRESQL_HOST' and 'POSTGRESQL_DIALECT' in .env.
````
### 5. Run
````
# Install dependencies
npm install
# Create tables
npm run migrate
# Seed apps table
npm run seed
# Start
npm start
````
# Built With
* [Node.js](https://nodejs.org/en/)
# Authors
* [xxgicoxx](https://github.com/xxgicoxx)
# Acknowledgments
* [FlatIcon](https://www.flaticon.com/)