https://github.com/thejoin95/train-app
https://github.com/thejoin95/train-app
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/thejoin95/train-app
- Owner: TheJoin95
- License: mit
- Created: 2024-08-01T13:57:29.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-30T20:46:20.000Z (almost 2 years ago)
- Last Synced: 2026-01-22T03:33:49.509Z (5 months ago)
- Language: TypeScript
- Size: 1.34 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Train App - Get your train at the cheapest price
[](https://opensource.org/licenses/MIT)
**NOTE**: the project is for styuding, fun and personal purpose only. Please contact Omio for real API.
This project is a scraper designed to pull data from [Omio.com](https://www.omio.com/) for trains, flights, and buses for a specified route. It helps users monitor and compare prices, sending notifications when cheaper travel options become available.
## Features
- Scrapes train, flight, and bus prices from Omio.com
- Monitors specific routes over time
- Sends notifications when cheaper travel options are found
- Easy to set up and customize for different routes
- Lightweight and efficient
- Comes with Prisma with MongoDB and LavinMQ
## How It Works
1. **Input the route**: Define the start and end destinations.
2. **Scrape prices**: The scraper will collect all the available train, flight, and bus prices for that route.
3. **Monitor for cheaper options**: The system will continuously monitor prices and notify you when it finds a lower fare.
4. **Notification system**: You'll receive a notification (by email) when a cheaper option is available.
## Installation
1. Clone the repository:
```bash
git clone https://github.com/TheJoin95/train-app.git
cd train-app
```
2. Install the dependencies
```bash
npm i
```
3. Configure your environemnt
You need to setup your environment with MongoDB, your queue system and your smpt server in the following env variables:
```bash
MONGODB_USER
MONGODB_PASSWORD
DATABASE_URL
CLOUDAMQP_URL
GMAIL_USER
GMAIL_PWD
```
I personally created a MongoDB instance with MongoDB Atlas and used CloudAMQP to create the LavinMQ.
Of course I've used my personal gmail for notification.
4. Sync your Prisma with your DB
5. Add some record in the times collection such as like:
```json
{
"outbound": {
"stations": {
"departure": "Paris",
"arrival": "Rennes"
},
"date": {
"$date": "2024-11-01T10:15:00.000Z"
}
},
"inbound": {
"stations": {
"departure": "Rennes",
"arrival": "Paris"
},
"date": {
"$date": "2024-11-03T10:15:00.000Z"
}
}
}
```
6. Run `./run-producer.sh`
7. Run `./run-queue.sh`
# License
MIT