Skip to content

Latest commit

 

History

History
97 lines (62 loc) · 2.19 KB

README.md

File metadata and controls

97 lines (62 loc) · 2.19 KB
Raw

About mieszkania_bot_parser

This is a Telegram bot that helps to find a rental apartment in Poland according to your parameters!

The reason I decided to develop it - I was looking for an apartment in Warsaw for a weeks but wasn't able to find appropriate. The average TTL(time to live) of the advertisement was 5 mins. If you don't call first - forget about the apartment, it'll be occupied. After the bot was set up I found a good apartment just in a day.

Hope it'll help somebody as it helped to me. Enjoy using it!

Built with

Installation steps

  1. Clone the repo

    $ git clone https://github.com/your_username/mieszkania_bot_parser.git

  2. Install NPM packages

    $ yarn install

  3. Add following environment variables in .env file (values - just for instance)

    MONGODB_LOGIN=MongoUser
MONGODB_PASSWORD=MN7nFwmL22YOdl7E
MONGODB_HOST=clustername.bk29f.mongodb.net
BOT_TOKEN=270485614:AAHfiqksKZ8WmR2zSjiQ7_v4TMAKdiHm9T0
DEFAULT_PARSING_FREQUENCY=0.5

  4. Start the project locally

    $ yarn start:dev

Deployment to Heroku

  1. Log in to Heroku

    $ heroku login

  2. Create Heroku app

    $ heroku create -a <app name>

  3. Push app to Heroku

    $ git push heroku <branch name>

Useful Links:

Roadmap

  • Provide a DB support
  • Add Link to current actual working Bot
  • Add 1-2 more sites to parse
  • Add Test Coverage
  • Add Multi-language Support
  • Move from MongoDB to Heroku Postgres

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)