You've already forked Php-Template
Ron Rise
78d5213892
All checks were successful
🧪✨ Tests Workflow / 🛡️ 🔒 Library Audit (push) Successful in 1m34s
🧪✨ Tests Workflow / 📝 ✨ Code Lint (push) Successful in 1m24s
🧪✨ Tests Workflow / 🛡️ 🔒 License Check (push) Successful in 1m38s
🧪✨ Tests Workflow / 🧪 ✨ Database Migrations (push) Successful in 1m49s
🧪✨ Tests Workflow / 🐙 🔍 Code Sniffer (push) Successful in 1m41s
🧪✨ Tests Workflow / 🧪 ✅ Unit Tests (push) Successful in 56s
🏗️✨ Build Workflow / 🖥️ 🔨 Build (push) Successful in 12m39s
🏗️✨ Build Workflow / 🖥️ 🔨 Build Migrations (push) Successful in 1m35s
Reviewed-on: #5 Co-authored-by: Ron Rise <ron@siteworxpro.com> Co-committed-by: Ron Rise <ron@siteworxpro.com>
73 lines
2.3 KiB
Markdown
73 lines
2.3 KiB
Markdown
# Template
|
|
|
|
|
|
|
|
## Dev Environment
|
|
|
|
### Prerequisites
|
|
- Docker
|
|
- Docker Compose
|
|
|
|
### migrations
|
|
|
|
create a new migration
|
|
```shell
|
|
docker run --rm -v $(PWD):/app siteworxpro/migrate:v4.18.3 create -ext sql -dir /app/db/migrations -seq create_users_table
|
|
```
|
|
|
|
```text
|
|
postgres://siteworxpro:password@localhost:5432/siteworxpro?sslmode=disable
|
|
```
|
|
|
|
```shell
|
|
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
|
|
```shell
|
|
docker-compose up -d
|
|
```
|
|
### Start the server
|
|
```shell
|
|
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
|
|
```shell
|
|
docker exec -it template-runtime-1 bin/xdebug.sh
|
|
```
|
|
|
|
### Install the dependencies
|
|
```shell
|
|
docker run --rm -v $(PWD):/app siteworxpro/composer install --ignore-platform-reqs
|
|
```
|
|
|
|
### Running all tests
|
|
```shell
|
|
docker run --rm -v $(PWD):/app siteworxpro/composer run tests:all
|
|
```
|
|
|
|
|
|
## License
|
|
|
|
```text
|
|
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.
|
|
``` |