Release

Author: Clivern

.env

@@ -15,30 +15,63 @@
 # https://symfony.com/doc/current/best_practices.html#use-environment-variables-for-infrastructure-configuration
 
 ###> symfony/framework-bundle ###
-APP_ENV=dev
-APP_SECRET=7062d89c55fcf1cc4c09fce5e978a22a
+APP_ENV=prod
+APP_SECRET=3999bf7e3a408f15942779447e01dd7a
+APP_TIMEZONE=UTC
+APP_LOCALE=en
 ###< symfony/framework-bundle ###
 
-###> symfony/webapp-pack ###
-MESSENGER_TRANSPORT_DSN=doctrine://default?auto_setup=0
-###< symfony/webapp-pack ###
-
 ###> doctrine/doctrine-bundle ###
 # Format described at https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url
 # IMPORTANT: You MUST configure your server version, either here or in config/packages/doctrine.yaml
 #
-# DATABASE_URL="sqlite:///%kernel.project_dir%/var/data.db"
-# DATABASE_URL="mysql://app:[email protected]:3306/app?serverVersion=8&charset=utf8mb4"
-DATABASE_URL="postgresql://app:[email protected]:5432/app?serverVersion=14&charset=utf8"
+# DATABASE_URL=mysql://root:[email protected]:3306/helium?serverVersion=8&charset=utf8mb4
+DATABASE_URL="sqlite:///%kernel.project_dir%/var/data.db"
 ###< doctrine/doctrine-bundle ###
+###> symfony/mailer ###
+MAILER_DSN=sendmail://default
+###< symfony/mailer ###
 
 ###> symfony/messenger ###
 # Choose one of the transports below
-# MESSENGER_TRANSPORT_DSN=doctrine://default
+MESSENGER_TRANSPORT_DSN=doctrine://default
 # MESSENGER_TRANSPORT_DSN=amqp://guest:guest@localhost:5672/%2f/messages
 # MESSENGER_TRANSPORT_DSN=redis://localhost:6379/messages
 ###< symfony/messenger ###
 
-###> symfony/mailer ###
-# MAILER_DSN=null://null
-###< symfony/mailer ###
+###> symfony/amazon-mailer ###
+# MAILER_DSN=ses://ACCESS_KEY:SECRET_KEY@default?region=eu-west-1
+# MAILER_DSN=ses+smtp://ACCESS_KEY:SECRET_KEY@default?region=eu-west-1
+###< symfony/amazon-mailer ###
+
+###> symfony/mailchimp-mailer ###
+# MAILER_DSN=mandrill://KEY@default
+# MAILER_DSN=mandrill+smtp://USERNAME:PASSWORD@default
+###< symfony/mailchimp-mailer ###
+
+###> symfony/mailgun-mailer ###
+# MAILER_DSN=mailgun://KEY:DOMAIN@default?region=us
+# MAILER_DSN=mailgun+smtp://USERNAME:PASSWORD@default?region=us
+###< symfony/mailgun-mailer ###
+
+###> symfony/mailjet-mailer ###
+# MAILER_DSN=mailjet+api://PUBLIC_KEY:[email protected]
+# MAILER_DSN=mailjet+smtp://PUBLIC_KEY:[email protected]
+###< symfony/mailjet-mailer ###
+
+###> symfony/postmark-mailer ###
+# MAILER_DSN=postmark://ID@default
+###< symfony/postmark-mailer ###
+
+###> symfony/sendgrid-mailer ###
+# MAILER_DSN=sendgrid://KEY@default
+###< symfony/sendgrid-mailer ###
+
+###> symfony/sendinblue-mailer ###
+# MAILER_DSN=sendinblue+api://KEY@default
+# MAILER_DSN=sendinblue+smtp://USERNAME:PASSWORD@default
+###< symfony/sendinblue-mailer ###
+
+###> symfony/mailtrap ###
+# MAILER_DSN=smtp://USERNAME:[email protected]:2525?encryption=tls&auth_mode=login
+###< symfony/mailtrap ###

.env.test

@@ -4,3 +4,4 @@ APP_SECRET='$ecretf0rt3st'
 SYMFONY_DEPRECATIONS_HELPER=999999
 PANTHER_APP_ENV=panther
 PANTHER_ERROR_SCREENSHOT_DIR=./var/error-screenshots
+APP_TIMEZONE=UTC

.gitattributes

@@ -0,0 +1 @@
+public/static/** linguist-vendored

.github/FUNDING.yml

@@ -1 +1,2 @@
-github: clivern
+github: # clivern
+custom: buymeacoffee.com/clivern

.github/workflows/php.yml

@@ -9,7 +9,7 @@ jobs:
       fail-fast: false
       matrix:
         operating-system: [ ubuntu-latest ]
-        php: [ '7.2', '7.4', '8.0', '8.1' ]
+        php: [ '7.4', '8.0', '8.1' ]
     name: Run CI PHP ${{ matrix.php }}
     steps:
       - uses: actions/checkout@master

.gitignore

@@ -23,3 +23,6 @@
 /.php-cs-fixer.php
 /.php-cs-fixer.cache
 ###< friendsofphp/php-cs-fixer ###
+code.zip
+helium.zip
+screenshots.zip

.php-cs-fixer.dist.php

@@ -8,7 +8,7 @@
 
 
 $fileHeaderComment = <<<COMMENT
-This file is part of the Clivern/Weekly project.
+This file is part of the Clivern/Helium project.
 (c) Clivern <[email protected]>
 COMMENT;
 

Makefile

@@ -1,119 +1,163 @@
-COMPOSER ?= composer
+composer ?= composer
 PHPUNIT_OPTS =
-SYMFONY = symfony
-PHP = php
+symfony = symfony
+php = php
+docker = docker
+cargo = cargo
+mdbook = mdbook
 
 
 help: Makefile
 	@echo
-	@echo " Choose a command run in Weekly:"
+	@echo " Choose a command run in Helium:"
 	@echo
 	@sed -n 's/^##//p' $< | column -t -s ':' |  sed -e 's/^/ /'
 	@echo
 
 
-composer:
-	$(COMPOSER) install
+## purge: Clear the cache
+.PHONY: purge
+purge:
+	@echo ">> ============= Clear Cache ============= <<"
+	-rm -rf var/cache/*
+	-rm -rf var/logs/*
+	-rm var/data.db
 
 
-cc:
-	rm -rf var/cache/*
+## composer: Install packages
+.PHONY: composer
+composer:
+	@echo ">> ============= Install Packages ============= <<"
+	@$(composer) install
 
 
-clear: cc
-	rm -rf var/logs/*
+## prod_composer: Install packages on production
+.PHONY: prod_composer
+prod_composer:
+	@echo ">> ============= Install Packages On Production ============= <<"
+	@$(composer) install  --no-dev --optimize-autoloader
 
 
+## fix-diff: Format diff
+.PHONY: fix-diff
 fix-diff:
+	@echo ">> ============= Fix code diff ============= <<"
 	./vendor/bin/php-cs-fixer fix --diff --dry-run -v
 
 
-clear_db:
-	rm -f ./var/cache/data.db
-
-
+## migrate: Migrate the database
+.PHONY: migrate
 migrate:
-	@echo "\n==> Migrate DB Tables"
-	$(PHP) bin/console doctrine:schema:update --force
+	@echo ">> ============= Run db migration ============= <<"
+	@$(php) bin/console doctrine:schema:update --force
 
 
-test: cc composer clear_db migrate
+## test: Run test cases
+.PHONY: test
+test: purge composer migrate
+	@echo ">> ============= Run test cases ============= <<"
 	bin/phpunit -c . $(PHPUNIT_OPTS) --log-junit build/phpunit.xml --coverage-text
 
 
-lint: cc lint-yaml lint-php phpcs php-cs lint-composer lint-eol
-	@echo All good.
-
-
-lint-eol:
-	@echo "\n==> Validating unix style line endings of files:files"
-	@! grep -lIUr --color '^M' config/ public/ src/ composer.json composer.lock || ( echo '[ERROR] Above files have CRLF line endings' && exit 1 )
-	@echo All files have valid line endings
-
-
-lint-composer:
-	@echo "\n==> Validating composer.json and composer.lock:"
-	$(COMPOSER) validate --strict
-
-
-lint-yaml:
-	@echo "\n==> Validating all yaml files:"
+## lint: Lint all the things
+.PHONY: lint
+lint: purge composer migrate
+	@echo ">> ============= Lint all the things ============= <<"
+	@! grep -lIUr --color '^M' config/ src/ composer.json composer.lock || ( echo '[ERROR] Above files have CRLF line endings' && exit 1 )
+	$(composer) validate --strict
 	./bin/console lint:yaml config
 	@find config -type f -name \*.yaml | while read file; do echo -n "$$file"; php bin/console --no-debug --no-interaction --env=test lint:yaml "$$file" || exit 1; done
-
-
-lint-php:
-	@echo "\n==> Validating all php files:"
 	@find src tests -type f -name \*.php | while read file; do php -l "$$file" || exit 1; done
-
-
-phpcs:
 	./vendor/bin/phpcs
-
-
-php-cs:
 	./vendor/bin/php-cs-fixer fix --diff --dry-run -v
 
 
-analyse:
-	@echo "\n==> Run phpstan analyse:"
-	vendor/bin/phpstan analyse src --memory-limit=-1
-
-
 ## coverage: Get Coverage Report
+.PHONY: coverage
 coverage: cc composer
-	@echo "\n==> Get Coverage Report:"
+	@echo ">> ============= Get Coverage Report ============= <<"
 	mkdir -p build/coverage
 	bin/phpunit  --log-junit build/phpunit.xml
 
 
 ## fix: Fix Style Issues
+.PHONY: fix
 fix:
-	@echo "\n==> Fix Style Issues:"
+	@echo ">> ============= Fix Code Format ============= <<"
 	./vendor/bin/php-cs-fixer fix
 
 
-## ci: Run CI Checks
-ci: config clear composer lint test analyse
-	@echo "All quality checks passed"
-
-
-## run: Run Weekly
+## run: Run Helium
+.PHONY: run
 run:
-	@echo "\n==> Run Weekly:"
-	$(SYMFONY) serve
+	@echo ">> ============= Run App ============= <<"
+	@$(symfony) serve --no-tls
 
 
 ## installed: Show a list of installed packages
+.PHONY: installed
 installed:
-	@echo "\n==> Show a list of installed packages:"
-	$(COMPOSER) show -i
+	@echo ">> ============= Show Installed Packages ============= <<"
+	@$(composer) show -i
 
 
 ## outdated: Show a list of outdated packages
+.PHONY: outdated
 outdated:
-	@echo "\n==> Show a list of outdated packages:"
-	$(COMPOSER) outdated
+	@echo ">> ============= Show Outdated Packages ============= <<"
+	@$(composer) outdated
+
+
+## db: Run a db container
+.PHONY: db
+db:
+	@echo ">> ============= Run a docker container ============= <<"
+	@$(docker) run -d --name=mysql-server \
+		-p 3306:3306 \
+		-v mysql-data:/var/lib/mysql \
+		-e MYSQL_ROOT_PASSWORD=root mysql
+
+
+## mdbook: Install mdbook rust package (Rust and Cargo needed)
+.PHONY: mdbook
+mdbook:
+	@echo ">> ============= Install mdbook ============= <<"
+	@$(cargo) install mdbook
+
+
+## docs: Build docs
+.PHONY: docs
+docs:
+	@echo ">> ============= Building docs ============= <<"
+	@$(mdbook) build docs
+
+
+
+## dasyn: Debug async messages and handlers
+.PHONY: dasyn
+dasyn:
+	@echo ">> ============= Debug Messenger ============= <<"
+	@$(php) bin/console debug:messenger
+
+
+## worker: Run async tasks
+.PHONY: worker
+worker:
+	@echo ">> ============= Run Worker ============= <<"
+	@$(php) bin/console messenger:consume async -vv
+
+
+## watch: Watch for new newsletters
+.PHONY: watch
+watch:
+	@echo ">> ============= Watch Newsletter ============= <<"
+	@$(php) bin/console watch
+
+
+## ci: Run CI Checks
+.PHONY: ci
+ci: config purge composer lint test
+	@echo "All Quality Checks Passed"
 
 
 .PHONY: help