https://github.com/xxgicoxx/rastreaqui-bot
Telegram bot for track Correios objects.
https://github.com/xxgicoxx/rastreaqui-bot
correios correiosjs objects track
Last synced: 10 months ago
JSON representation
Telegram bot for track Correios objects.
- Host: GitHub
- URL: https://github.com/xxgicoxx/rastreaqui-bot
- Owner: xxgicoxx
- License: mit
- Created: 2019-12-14T06:04:38.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-19T22:59:10.000Z (over 2 years ago)
- Last Synced: 2025-02-18T11:57:22.402Z (10 months ago)
- Topics: correios, correiosjs, objects, track
- Language: JavaScript
- Homepage:
- Size: 81.1 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# RastreAQUI
Telegram bot for track Correios objects.
# Features
* /add `code` `name` - Add object
* /remove `code` - Remove object
* /check `code` - Check object
* /list - List objects
* /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. PostgreSQL
````
# Install
Install PostgreSQL and create an database.
# Configure
Set PostgreSQL 'POSTGRESQL_USERNAME', 'POSTGRESQL_PASSWORD', 'POSTGRESQL_DATABASE', 'POSTGRESQL_HOST' and 'POSTGRESQL_DIALECT' in .env.
````
### 4. Run
````
# Install dependencies
npm install
# Create tables
npm run migrate
# Seed tables
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/)