You've already forked framexEngine-pro
69 lines
2.6 KiB
Markdown
69 lines
2.6 KiB
Markdown
|
|
|
|
# About Framex
|
|
|
|
Hi, I am **Thanos**. I have been involved with computers, hardware, and practical IT work since 1995. Framex is a small PHP project I built and refined through real use, mostly for fast static pages, custom CSS experiments, presentations, API-driven pages, and lightweight content sites.
|
|
|
|
|
|
|
|
## Why this project exists
|
|
|
|
Framex is built around one simple idea: a website should be easy to understand from its files.
|
|
|
|
Routes map to files in `app/views`, templates live in `templates`, public assets live in `public`, and styling is handled through Tailwind CSS 4 or any CSS approach you prefer. There is no heavy framework layer to learn before you can build a page.
|
|
|
|
## What it is good for
|
|
|
|
- **Static websites** that need clean URLs and reusable templates.
|
|
- **Markdown documentation** with automatic typography and dark-mode support.
|
|
- **Small business websites** where speed and maintainability matter.
|
|
- **Custom landing pages** with modern Tailwind components.
|
|
- **API-powered pages** when you need PHP logic without a large framework.
|
|
- **Presentations and prototypes** that should stay portable and simple.
|
|
|
|
## Design goals
|
|
|
|
Framex tries to stay:
|
|
|
|
- **Lightweight:** only the pieces needed to render pages clearly.
|
|
- **Fast:** no unnecessary runtime complexity.
|
|
- **Readable:** routes, views, templates, and assets are easy to find.
|
|
- **Flexible:** use PHP views, Markdown views, Tailwind CSS, or plain CSS.
|
|
- **Practical:** built for developers who want to ship pages without ceremony.
|
|
|
|
## How pages work
|
|
|
|
A URL such as `/about` resolves to a file like:
|
|
|
|
```text
|
|
app/views/about/index.md
|
|
```
|
|
|
|
A URL such as `/demo/blog-post` resolves to:
|
|
|
|
```text
|
|
app/views/demo/blog-post.php
|
|
```
|
|
|
|
Markdown pages are automatically parsed and styled. PHP pages can use custom markup, arrays, loops, metadata, and reusable helpers.
|
|
|
|
## Usage
|
|
|
|
You can use, extend, modify, reduce, or rebuild this project for personal and commercial work. Treat it as a starting point, not a locked system.
|
|
|
|
Good next steps:
|
|
|
|
- Read the [documentation](/docs).
|
|
- Explore the [demo pages](/demo).
|
|
- Create a new PHP view in `app/views`.
|
|
- Create a new Markdown page with `index.md`.
|
|
- Rebuild CSS with `npm run build:css` when you add new Tailwind classes.
|
|
|
|
## Disclaimer
|
|
|
|
This is a personal project shared for developers and people who understand how to work with PHP projects. I have used it for years without issues, but you are responsible for how you use it, modify it, deploy it, and secure it.
|
|
|
|
Use it carefully, make backups, and review the code before using it in production.
|
|
|
|
**Enjoy building.**
|