Skip to content

Commit dfea275

Browse files
committed
Revert installer scaffolding and restore contributor-focused README
1 parent e285151 commit dfea275

6 files changed

Lines changed: 42 additions & 567 deletions

File tree

README.md

Lines changed: 42 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -11,74 +11,72 @@
1111

1212
PSFS is a lightweight PHP framework for MVC/API applications (Twig + Propel + Symfony components).
1313

14-
## Quick Install (Copy/Paste)
14+
## 5-minute setup
1515

16-
Requirements:
17-
- `bash`
18-
- `docker compose` or `php + composer`
16+
Prerequisites:
1917

20-
Using `curl`:
18+
- Docker + Docker Compose
19+
- Git
2120

21+
<!-- validated -->
2222
```bash
23-
curl -fsSL https://raw.githubusercontent.com/psfs/core/master/install.sh | bash
23+
docker compose up -d
24+
docker compose ps
25+
docker exec core-php-1 php -v
26+
docker exec core-php-1 composer install --no-interaction --prefer-dist
2427
```
2528

26-
Using `wget`:
29+
If your PHP container name is not `core-php-1`:
2730

31+
<!-- validated -->
2832
```bash
29-
wget -qO- https://raw.githubusercontent.com/psfs/core/master/install.sh | bash
33+
docker compose ps
34+
docker ps --format '{{.Names}}'
3035
```
3136

32-
The installer downloads and runs the official PSFS project generator.
37+
## Daily command map
3338

34-
## Create a Project
39+
<!-- example-only -->
40+
```bash
41+
# Run key tests
42+
docker exec core-php-1 php vendor/bin/phpunit --no-coverage --filter '/(AuthApiTest|RequestResponseSecurityContractTest)/'
3543

36-
Interactive:
44+
# List PSFS CLI commands
45+
docker exec core-php-1 php src/bin/psfs list
3746

38-
```bash
39-
./scripts/create-psfs-project.sh
47+
# Security local pre-check (act)
48+
act push --container-architecture linux/amd64
4049
```
4150

42-
Non-interactive:
51+
## Choose your path
4352

44-
```bash
45-
./scripts/create-psfs-project.sh \
46-
--non-interactive \
47-
--name my-psfs-app \
48-
--path /tmp/my-psfs-app \
49-
--runtime docker \
50-
--package acme/my-psfs-app \
51-
--description "My PSFS app" \
52-
--author "Your Name"
53-
```
53+
### Onboarding path
5454

55-
Remote install with flags:
55+
1. Read [Operations Playbook](./doc/OPERATIONS.md)
56+
2. Read [DTO Validation Engine](./doc/DTO_VALIDATION.md)
57+
3. Execute the "First day" flow
58+
4. Use troubleshooting matrix when blocked
5659

57-
```bash
58-
curl -fsSL https://raw.githubusercontent.com/psfs/core/master/install.sh | bash -s -- \
59-
--non-interactive \
60-
--name my-psfs-app \
61-
--runtime docker \
62-
--package acme/my-psfs-app
63-
```
60+
### Core contributor path
61+
62+
1. Read [Operations Playbook](./doc/OPERATIONS.md)
63+
2. Read [DTO Validation Engine](./doc/DTO_VALIDATION.md)
64+
3. Read [Propel Workflow](./doc/PROPEL_WORKFLOW.md)
65+
4. Run key tests and validate changes in Docker
6466

65-
## What the Generator Does
67+
## Propel models and migrations
6668

67-
- Detects `local` runtime (`php` + `composer`) and `docker` runtime (`docker compose`).
68-
- If both are available in interactive mode, prompts for runtime selection.
69-
- Generates PSFS base structure (`config`, `html`, `src`, `cache`, `logs`, `locale`).
70-
- Generates initial `composer.json`.
71-
- For Docker runtime, generates `docker-compose.yml`, `docker/php.ini`, and `.env.example`.
72-
- Does not auto-run dependency install or container startup.
69+
For operational Propel flow (schema, model generation context, migration execution, rollback, failure modes), see:
70+
71+
- [Propel Workflow](./doc/PROPEL_WORKFLOW.md)
7372

74-
## Documentation
73+
## Documentation index
7574

7675
- [Operations Playbook](./doc/OPERATIONS.md)
7776
- [DTO Validation Engine](./doc/DTO_VALIDATION.md)
7877
- [Propel Workflow](./doc/PROPEL_WORKFLOW.md)
79-
- [Core Contracts](./doc/CONTRACTS.md)
8078

81-
## Notes
79+
## Rules
8280

83-
- Runtime baseline for this repository is Docker Compose with PHP 8.3.
84-
- For project internals and contributor workflows, use the docs listed above.
81+
- Run project commands inside Docker containers.
82+
- Keep command blocks explicitly tagged as `validated` or `example-only`.

install.sh

Lines changed: 0 additions & 39 deletions
This file was deleted.

0 commit comments

Comments
 (0)