Goshne Prro

Goshne Prro is a project to find discounts on Snapp Food and Snap Market and more in the future. It can find discounts based on the user's location and the user's favorite vendors/products and discount percentage.

Requirements

You can use any Laravel Pulse compatible database, such as MySQL, MariaDB, or PostgreSQL, but for caching you need to use Redis version 7.4.0 or higher. but for caching you need to use Redis version 7.4.0 or higher. The reason is usage of HEXPIRE command in Redis which is available in Redis 7.4 and higher. info

Installation

Development Environment (Laravel Sail)

You can read the Laravel Sail documentation for more information.

# clone the repository
git clone https://github.com/ahbanavi/goshneprro.git
cd goshneprro

# write your .env file (don't forget to put app key)
cp .env.example .env

# install the dependencies
docker run --rm \
    -u "$(id -u):$(id -g)" \
    -v "$(pwd):/var/www/html" \
    -w /var/www/html \
    laravelsail/php83-composer:latest \
    composer install --ignore-platform-reqs

# build and run the containers
./vendor/bin/sail up -d

# run the migrations
./vendor/bin/sail artisan migrate

# Create admin user
./vendor/bin/sail artisan make:admin-user

# run schedule in the background 
./vendor/bin/sail artisan schedule:work -n &

# run queue worker in the background
./vendor/bin/sail artisan queue:work -v -n &

Production Environment (Docker)

You can use the following commands to set up the app in a production environment using Docker.

# create a directory for the app to hold .env and docker-compose.yml
mkdir goshneprro-docker
cd goshneprro-docker

# download .env file and write your configurations
curl -o .env https://raw.githubusercontent.com/ahbanavi/goshneprro/main/.env.example

# download docker-compose.yml file
curl -o docker-compose.yml https://raw.githubusercontent.com/ahbanavi/goshneprro/main/docker-compose-production.yml

# run the containers
docker compose up -d

# run the migrations
docker compose exec app php artisan migrate

# Create admin user
docker compose exec app php artisan make:admin-user

Web Server Configuration (Nginx)

You can use any web server you want and forward the requests to the app container fpm port (above docker-compose file uses port 10090).

But here is an example of Nginx setup and configuration on Ubuntu/Debian systems after setting up the app as mentioned above:

# Install Nginx
sudo apt update
sudo apt install nginx

# Start and enable Nginx
sudo systemctl start nginx
sudo systemctl enable nginx

# Create a new Nginx configuration file
curl -o /etc/nginx/sites-available/example.com.conf https://raw.githubusercontent.com/ahbanavi/goshneprro/main/.docker/nginx/nginx.conf

# Enable the new configuration
sudo ln -s /etc/nginx/sites-available/example.com.conf /etc/nginx/sites-enabled/

# Copy app public directory to the Nginx root directory
docker cp goshneprro_app_main:/var/www/html/public /var/www/example.com/public

# Test Nginx configuration
nginx -t

# Reload Nginx
nginx -s reload

Update

cd goshneprro-docker
docker compose pull app && docker compose up -d

# run the migrations
docker compose exec app php artisan migrate

Configuration

Besides the default Laravel environment variables, you can set the following variables specifically for Goshne Prro:

Var	Description	Required	Default
TELEGRAM_BOT_TOKEN	Telegram bot token	Yes	-
TELEGRAM_BOT_BASE_URI	Base URI (Bridge) for the Telegram Bot API	No	https://api.telegram.org
MARKET_PARTY_PRODUCTS_TTL	Time-to-live (TTL) for market party products caches in seconds	No	900
MARKET_PARTY_NOTIFY_TTL	TTL for market party notifications cache in seconds	No	43200
FOOD_PARTY_NOTIFY_TTL	TTL for food party notifications cache in seconds	No	43200
FOOD_PARTY_SCHEDULE	Cron schedule for food party runs	No	"*/15 * * * *"
MARKET_PARTY_SCHEDULE	Cron schedule for market party runs	No	"*/15 * * * *"
DEFAULT_LATITUDE	Default latitude for UI map	No	36.32112700482277 (Mashhad)
DEFAULT_LONGITUDE	Default longitude for UI map	No	59.53740119934083 (Mashhad)
DEFAULT_IMAGE	Default image for notifications	No	Image

License

This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License. You are free to share, copy and adapt the material in any medium or format for non-commercial purposes with proper attribution, providing a link to the license, and indicating if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.