/get-me-a-date

:heart_eyes: Help me get a :cupid: date tonight :first_quarter_moon_with_face:

Primary LanguageJavaScriptMIT LicenseMIT

😍 Help me get a πŸ’˜ date tonight πŸŒ›

Coverage Status Known Vulnerabilities Docker Stars Docker Pulls

Uses AWS Rekognition deep learning-based image recognition to help you automate your date discovery.

Features

  • Supports Tinder dating app βœ…
  • Supports Happn dating app βœ…
  • Supports Mint dating app βœ…
  • Uses your existing matches πŸ’ž for machine-learning πŸ€– when to πŸ‘ or πŸ‘Ž new recommendations βœ…
  • Periodically πŸ•™ gets dating app πŸ‘§πŸ‘© recommendations and automatically πŸ€– πŸ‘ or πŸ‘Ž βœ…
  • Launch πŸš€ inside a Docker container 🐳 so you don't need to manage the dependencies πŸ™Œ βœ…

How to use

Use it in your terminal

Run the Docker image in a container exposing the port 5940

docker run -d -p "5940:3000" hfreire/get-me-a-date

Available REST API endpoints

Swagger documentation available at http://localhost:5940/docs.

Available environment variables

Variable Description Required Default value
FACEBOOK_USER_EMAIL Facebook user e-mail address used for login. true undefined
FACEBOOK_USER_PASSWORD Facebook user password used for login. true undefined
AWS_REGION AWS region used for S3 and Rekognition. true undefined
AWS_ACCESS_KEY_ID AWS access key used for S3 and Rekognition. true undefined
AWS_SECRET_ACCESS_KEY AWS secret access key used for S3 and Rekognition. true undefined
FIND_DATES_PERIOD The time period (in seconds) between finding dates. false 600
PORT The port to be used by the HTTP server. false 3000
API_KEYS The secret keys that should be used when securing endpoints. false undefined
SO_TIMEOUT TCP socket connection timeout. false 120000
LOG_LEVEL The log level verbosity. false info
ENVIRONMENT The environment the app is running on. false undefined
ROLLBAR_API_KEY The server API key used to talk with Rollbar. false undefined

How to build

Clone the GitHub repo

git clone https://github.com/hfreire/get-me-a-date.git

Change current directory

cd get-me-a-date

Run the NPM script that will build the Docker image

npm run build

How to contribute

You can contribute either with code (e.g., new features, bug fixes and documentation) or by donating 5 EUR. You can read the contributing guidelines for instructions on how to contribute with code.

All donation proceedings will go to the Sverige fΓΆr UNHCR, a swedish partner of the UNHCR - The UN Refugee Agency, a global organisation dedicated to saving lives, protecting rights and building a better future for refugees, forcibly displaced communities and stateless people.

License

Read the license for permissions and limitations.