baseline
This commit is contained in:
41
README.md
Normal file
41
README.md
Normal file
@@ -0,0 +1,41 @@
|
||||
<h1><img alt="MintyPHP" height="50" src="web/img/minty_square.png"> MintyPHP</h1>
|
||||
|
||||
MintyPHP aims to be a full-stack PHP 7 (or 8) framework that is:
|
||||
|
||||
- Easy to learn
|
||||
- Secure by design
|
||||
- Light-weight
|
||||
|
||||
By design, it does:
|
||||
|
||||
- … have one variable scope for all layers.
|
||||
- … require you to write SQL queries (no ORM).
|
||||
- … use PHP as a templating language.
|
||||
|
||||
Mainly to make it easy to learn for PHP developers.
|
||||
|
||||
[Download](https://mintyphp.github.io/installation/) /
|
||||
[Documentation](https://mintyphp.github.io/docs/)
|
||||
|
||||
## External links
|
||||
|
||||
- [MintyPHP v3 is released](https://tqdev.com/2022-mintyphp-v3-is-released)
|
||||
- [MintyPHP now on packagist!](https://tqdev.com/2018-mindaphp-now-on-packagist)
|
||||
|
||||
## Quickstart (Docker)
|
||||
|
||||
1. Copy `.env.example` to `.env` (defaults are fine for local dev).
|
||||
2. Build and start the stack:
|
||||
|
||||
```bash
|
||||
docker compose up --build
|
||||
```
|
||||
|
||||
3. Open the app at `http://localhost:8080`.
|
||||
4. Register a user, then visit `/admin` (protected route).
|
||||
5. phpMyAdmin is available at `http://localhost:8081`.
|
||||
|
||||
### Notes
|
||||
|
||||
- MintyPHP uses Memcached for its firewall cache; the compose stack includes a `memcached` service and the PHP container has the extension enabled.
|
||||
- `config/config.php` is generated and gitignored by default; adjust `.gitignore` if you want to commit it.
|
||||
Reference in New Issue
Block a user