Ron Rise 7aa14c0db3
All checks were successful
🧪✨ Tests Workflow / 🛡️ 🔒 Library Audit (push) Successful in 2m32s
🧪✨ Tests Workflow / 🧪 ✨ Database Migrations (push) Successful in 2m48s
🧪✨ Tests Workflow / 🛡️ 🔒 License Check (push) Successful in 2m33s
🧪✨ Tests Workflow / 📝 ✨ Code Lint (push) Successful in 2m44s
🧪✨ Tests Workflow / 🐙 🔍 Code Sniffer (push) Successful in 2m53s
🧪✨ Tests Workflow / 🧪 ✅ Unit Tests (push) Successful in 3m5s
more tests (#19)
Reviewed-on: #19
Co-authored-by: Ron Rise <ron@siteworxpro.com>
Co-committed-by: Ron Rise <ron@siteworxpro.com>
2025-11-16 16:40:09 +00:00
2025-11-16 16:40:09 +00:00
2025-04-29 12:13:45 -04:00
2025-11-16 16:40:09 +00:00
2025-11-16 16:40:09 +00:00
2025-04-25 20:59:13 -04:00
2025-11-11 14:52:29 +00:00
2025-11-16 16:40:09 +00:00
2025-11-16 16:40:09 +00:00
2025-11-16 16:40:09 +00:00
2025-11-12 20:29:42 +00:00
2025-04-25 22:53:18 -04:00
2025-04-25 22:27:47 -04:00
2025-10-16 00:24:58 +00:00
2025-11-11 14:52:29 +00:00

Template

pipeline status

Dev Environment

Prerequisites

  • Docker
  • Docker Compose

migrations

create a new migration

docker run --rm  -v $(PWD):/app siteworxpro/migrate:v4.18.3 create -ext sql -dir /app/db/migrations -seq create_users_table
postgres://siteworxpro:password@localhost:5432/siteworxpro?sslmode=disable
docker run --rm  -v $(PWD):/app siteworxpro/migrate:v4.18.3 -database "postgres://siteworxpro:password@localhost:5432/siteworxpro?sslmode=disable" -path /app/db/migrations up

Starting the Runtime

docker-compose up -d

Start the server

docker exec -it template-dev-runtime-1 rr serve

You can access the api at http://localhost:9501/

Xdebug

xdebug needs to be built into the container before it will work

 docker exec -it php-template-composer-runtime-1 bin/xdebug.sh

Install the dependencies

docker run --rm  -v $(PWD):/app siteworxpro/composer install --ignore-platform-reqs

Running all tests

docker run --rm  -v $(PWD):/app siteworxpro/composer run tests:all

License

Copyright (c)2025 Siteworx Professionals, LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation
files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Description
The is a starting point for a modern php api
Readme 639 KiB
v1.8.0 Latest
2025-12-04 16:50:35 +00:00
Languages
PHP 94.3%
Makefile 3.9%
Dockerfile 1.2%
Shell 0.6%