https://github.com/katherinemc2/tube-bot

Telegram Metro Alert Bot
https://github.com/katherinemc2/tube-bot

aws-cdk github-actions

Last synced: about 1 month ago
JSON representation

Telegram Metro Alert Bot

• Host: GitHub
• URL: https://github.com/katherinemc2/tube-bot
• Owner: KatherineMC2
• Created: 2024-09-12T09:28:31.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-12T11:09:09.000Z (4 months ago)
• Last Synced: 2024-10-15T16:21:35.646Z (3 months ago)
• Topics: aws-cdk, github-actions
• Language: TypeScript
• Homepage:
• Size: 89.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Telegram Metro Alert Bot

This project is a Telegram bot designed to send real-time alerts about metro line disruptions. It will notify users instantly when there are issues on metro lines, helping them avoid delays and plan their trips more efficiently.

# ⚠️ Early Development Stage:

The project is still in its early stages and not functional yet, but updates and improvements are planned as development continues. Build in NodeJs , Typescript, AWS CDK and Github Actions

# tube-bot

Folder structure

- packages -> service-bot

## Pre Requisites

You need to install NodeJS with node 20. 

Check it with: 

```

node -v

```

## Installation

Go to service-bot folder and install the dependencies

To install the dependencies from the package.lock  use 

```

npm ci

```

## Scripts

```

npm run fix      /// Tries to lint it and format it

npm run lint     /// Checks linting

npm run cdk deploy  /// Deploy Cdk

```