psuzn/Play-Deals-Backend

Backend for Play Deals

Play Deals

          

Play deals is a simple app that aggregates the paid apps that have ongoing deals and discounts, aka you can get the paid apps free or with discount.

Play Deals

Play deals is a simple app to aggregate the paid apps that have ongoing deals and discounts.

This repo contains the codebase for the backend for the actual app. It acts as a place to persist the deals and a place to add,validate the deals. This backend is built using Eclipse Vert.x™ and heavily makes use of kotlin coroutines.

Development

Running tests

./gradlew test

Configuration

Configuration can be done by passing environment variables listed below:

Best way provide configuration to create a .env file with the environmental variables and either

1. run just dev-run from terminal, OR
2. Install Envfile plugin for IntelliJ and run using IntelliJ

ENV_VAR	REQUIRED	DEFAULT	EXAMPLE	NOTES
DB_HOST	Y		localhost
DB_USERNAME	Y		whatever
FIREBASE_ADMIN_AUTH_CREDENTIALS	Y		whatever	Firebase admin auth credentials
FOREX_API_KEY	Y		whatever	Api key for https://exchangeratesapi.io
DB_PASSWORD	N	password	whatever
DB_PORT	N	5432	6868
DB_NAME	N	play_deals	whatever
DB_POOL_SIZE	N	5	6
ENV	N	PRODUCTION	PRODUCTION	one of PRODUCTION or DEVELOPMENT or TEST
APP_PORT	N	8888	9999
POSTGRES_IMAGE	N	postgres:14		Useful for testing new versions of postgres. Used only in test code
DASHBOARD	N	true	false	Whether to enable or not the Jobrunr dashboard
DASHBOARD_USER	N	admin	whatever	Jobrunr dashboard login credential
DASHBOARD_PASS	N	admin	whatever	Jobrunr dashboard login credential
CORS	N	*	whatever	origins allowed for CORS

License

GPL V3 License

Copyright (c) 2023 Sujan Poudel