/airbnbot

🤖 Slack app to fetch deals from the hidden Airbnb API.

Primary LanguageTypeScriptMIT LicenseMIT

airbnbot

Getting started   •   Tech/frameworks used   •   License

Build Status Maintainability Status Maintainability Status Test Coverage Status FOSSA Status

🏁 Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

The simplest way to enjoy this NodeJS application is to run it in a Docker container, so make sure you have Docker CE installed: https://docs.docker.com/install/

Installation

Clone the repository:

git clone https://github.com/2n3g5c9/airbnbot

Write a .env file with the following environment variables:

CLIENT_ID=""
CLIENT_SECRET=""
AIRBNBOT_ICON_URL=""
AIRBNB_CLIENT_SESSION_ID=""
AIRBNB_KEY=""

Then simply build the image (less than 80MB) and run a container in the background with the provided docker-compose configuration file:

docker-compose up -d

How to use

Simply send /london help to your Slack bot to get instructions on how to use the command. Keep in mind this works for bookings in London but feel free to customize!

Following is an example on how to use Airbnbot:

airbnbot-screenshot

🪄 Tech/frameworks used

  • Node.js: JavaScript runtime built on Chrome's V8 JavaScript engine.
  • Typescript: Typed superset of JavaScript that compiles to plain JavaScript.
  • Express: Fast, unopinionated, minimalist web framework for Node.js.
  • Webpack: Bundler for javascript and friends.
  • Distroless: Language focused docker images, minus the operating system.

📃 License

This project is licensed under the MIT License - see the LICENSE file for details