You've already forked Php-Template
fixed the israeli-palestinian conflict
This commit is contained in:
52
README.md
52
README.md
@@ -1,26 +1,56 @@
|
|||||||
# Template
|
# Template
|
||||||
|
|
||||||
|
## Dev Environment
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
- Docker
|
||||||
|
- Docker Compose
|
||||||
|
|
||||||
|
### Starting the Runtime
|
||||||
```shell
|
```shell
|
||||||
export PHP_IDE_CONFIG=serverName=localhost
|
docker-compose up -d
|
||||||
|
```
|
||||||
|
### Start the server
|
||||||
|
```shell
|
||||||
|
docker exec -it template-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
|
```shell
|
||||||
docker run --rm -v $(PWD):/app siteworxpro/composer run tests:all
|
docker run --rm -v $(PWD):/app siteworxpro/composer run tests:all
|
||||||
```
|
```
|
||||||
|
|
||||||
### 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
|
|
||||||
```
|
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
```text
|
```text
|
||||||
postgres://siteworxpro:password@localhost:5432/siteworxpro?sslmode=disable
|
Copyright (c)2025 Siteworx Professionals, LLC
|
||||||
```
|
|
||||||
|
|
||||||
```shell
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
|
||||||
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
|
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.
|
||||||
```
|
```
|
||||||
Reference in New Issue
Block a user