https://github.com/angus6b23/telegram-membership-card-bot
A telegram bot allows you to save and share membership cards and gift cards with your family or friends
https://github.com/angus6b23/telegram-membership-card-bot
barcode gift-card grammy membership-card qrcode sqlite telegram-bot
Last synced: 7 months ago
JSON representation
A telegram bot allows you to save and share membership cards and gift cards with your family or friends
- Host: GitHub
- URL: https://github.com/angus6b23/telegram-membership-card-bot
- Owner: angus6b23
- License: gpl-3.0
- Created: 2025-03-21T21:48:41.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2025-03-22T19:49:04.000Z (7 months ago)
- Last Synced: 2025-03-22T20:27:27.312Z (7 months ago)
- Topics: barcode, gift-card, grammy, membership-card, qrcode, sqlite, telegram-bot
- Language: TypeScript
- Homepage:
- Size: 71.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Telegram Membership Card Bot
A telegram bot allows you to save and share membership cards and gift cards with your family or friends
## Screenshots
[screenshot1](https://raw.githubusercontent.com/angus6b23/telegram-membership-card-bot/master/assets/screenshots/screenshot-1.png)
[screenshot2](https://raw.githubusercontent.com/angus6b23/telegram-membership-card-bot/master/assets/screenshots/screenshot-2.png)
[screenshot3](https://raw.githubusercontent.com/angus6b23/telegram-membership-card-bot/master/assets/screenshots/screenshot-3.png)
[screenshot4](https://raw.githubusercontent.com/angus6b23/telegram-membership-card-bot/master/assets/screenshots/screenshot-4.png)
[screenshot5](https://raw.githubusercontent.com/angus6b23/telegram-membership-card-bot/master/assets/screenshots/screenshot-5.png)
[screenshot6](https://raw.githubusercontent.com/angus6b23/telegram-membership-card-bot/master/assets/screenshots/screenshot-6.png)
## Features
- Save and access your membership card and gift cards anywhere
- All codes are saved on your own instance
- Support common type of barcodes and qr codes
- Get code quickly by just typing the name of the code
- Role base access - Allow control which user is allowed to access membership cards and gift cards
- Keep track of the amount of remaining balance of your gift cards
- Large code generated easy for scanning at check-out machine
## Prerequisites
- A Telegram account for creating and interacting with the bot
- [Node.js](https://nodejs.org/) +/- [docker](https://www.docker.com/) installed on your machine
## Install / Deploying
1. Clone the git repository
`git clone https://codeberg.org/angus6b23/telegram-membership-card-bot.git`
2. Create your own telegram bot with [BotFather](https://telegram.me/BotFather) and save the token
- For details: See
3. Get the user id for your own telegram account with [Userinfo Bot](https://telegram.me/userinfobot)
4. Copy and Edit the environment variables required
`cp example.env .env`
then edit the .env file with your favorite editor (Set the bot token and user id you obtained on previous steps)
`nano .env`
`vim .env`
### With Node.js
5. Install dependencies using package manager
Using yarn
`yarn`
Using npm
`npm install`
6. Start the program
Using yarn
`yarn start`
Using npm
`npm run start`
### With docker (compose)
5. Build the application with package manager
Using yarn
`yarn build:docker`
Using npm
`npm run build:docker`
6. Start with the built image with docker compose
`docker compose up -d`
## License
This app is provided under GPL v3.0 or later. For details, please visit