Skip to content

Commit cffba71

Browse files
committed
new README
1 parent 6e8778c commit cffba71

File tree

1 file changed

+20
-91
lines changed

1 file changed

+20
-91
lines changed

README.md

Lines changed: 20 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,118 +1,47 @@
11
![Promo image](images/jet-logo.svg "PHP Jet")
22

3-
PHP Jet is a powerful **PHP8** framework aimed at maximizing the efficiency of developing all kinds of online applications.
43

5-
This framework allows you to work much faster and create much higher quality projects. With PHP Jet you can create both small projects and large scale projects for which it is primarily designed.
4+
# 🧰 Everything you need
65

7-
Of course, it includes **modularity / microservices / micro-app architecture**, **MVC architecture**, **ORM (MySQL/MariaDB, SQLite, PostgreSQL and MS SQL support, Oracle support development in progress)**, **REST API server** and so on, but above all, it offers **incredible performance, flexibility and freedom**.
6+
Completely [unique MVC](https://www.php-jet.net/doc/mvc-in-general/jet-mvc) that will make your work much easier, flexible and powerful [ORM](https://www.php-jet.net/doc/orm-datamodel), perfect forms, all ready for international environment, support for [authentication and authorization](https://www.php-jet.net/doc/auth-authentication-and-authorization) including roles and rights, REST, AJAX, server-side UI generation and [many more](https://www.php-jet.net/doc/) ...
87

9-
It is a modern framework that will **help you, make your work very efficiently** and **not limit** you.
8+
Last but not least, the whole system is modular and built on the principle of [micro-applications - application modules](https://www.php-jet.net/doc/application-modules). This will quite fundamentally improve your productivity, testing and deployment, work organization, code reusability and so on.
109

11-
It is a field-proven framework that has been developed for 12 years and practically used in various kinds of online applications and has recently been fully adapted to PHP8.
10+
# 🪛 Integrated tools
1211

13-
Framework places great emphasis not only on security and speed, but also on flexibility and adaptability.
12+
Of course, there is not only an integrated profiler, but also a comprehensive sample application, a pre-made admin panel, a pre-made installer and above all the unique and powerful Jet Studio tool that will make your work much easier.
1413

15-
PHP Jet is not only a library of classes, but includes **integrated development tools** such as **Jet Profiler** and **Jet Studio**, which **make work incredibly efficient and easy**.
1614

17-
This framework is developed for applications operated in the **European Union**. For this reason, it places great emphasis on the development of **localizable and cross-border applications**.
15+
# 🙂 Small and simple
1816

19-
This is **not a new** experimental project, but a practically used and **mature framework** that leverages more than twenty years of experience with the development of online applications of the author of this framework.
17+
Despite the fact that PHP Jet already includes everything you need in the base, including unique tools, everything remains as simple, small, easy to understand as possible. KISS - Keep It Simple and Straightforward.
2018

21-
Project website and documentation: https://www.php-jet.net/
19+
The best solution is always the simplest.
2220

23-
![Promo image](images/promo.png "PHP Jet")
2421

25-
## Quick testing (PHP built-in web server)
22+
# 🛈 Detailed documentation
2623

27-
It is possible to quickly try PHP Jet.
24+
Detailed and always up-to-date [documentation](https://www.php-jet.net/doc) is available. A large number of video tutorials will be produced in the near future.
2825

29-
All you need to do is:
30-
* Make sure you have PHP8 installed - PHP Jet requires PHP8 and newer.
31-
* [Download PHP Jet](https://github.com/mirekmarek/php-jet/releases) and unpack archive to some directory.
32-
* **OR**
33-
* Use composer:
34-
```composer create-project mirekmarek/php-jet```
35-
* Navigate to the directory where PHP Jet is
36-
* Run ```php _playground/start.php```
37-
* Open URL http://localhost:8000 (if you haven't specified something else during playground start) and proceed installation process.
26+
# ⚛ Modern
3827

39-
## Installation (Apache, NGINX)
28+
PHP Jet is fully customized for PHP 8. It uses typing, attributes and so on. It is fully future-ready.
4029

41-
PHP Jet is [distributed](https://github.com/mirekmarek/php-jet/releases) as one package which includes everything:
42-
* PHP Jet library
43-
* Example application
44-
* Example application installer
45-
* Profiler
46-
* Powerful development tool Jet Studio
4730

48-
All you have to do to try PHP Jet with "adult" webserver is:
49-
* Make sure you have PHP8 installed - PHP Jet requires PHP8 and newer.
50-
* [Download PHP Jet](https://github.com/mirekmarek/php-jet/releases) and unpack archive to some directory.
51-
* **OR**
52-
* Use composer:
53-
```composer create-project mirekmarek/php-jet```
54-
* Create some "virtual domain" in yours hosts file. For example: jet.lc.
55-
* You can create database (MySQL / MariaDB, PostgreSQL or MS SQL) for testing if you want. But it is not necessary, because PHP Jet supports SQLite database, and it's good enough for testing.
56-
* Configure your Apache (add virtual configuration) or NGINX (add server block) webserver.
57-
* Unpack package contains Jet and its example application into the directory which is the root directory of apache virtual / nginx server block.
58-
* Open virtual domain (for example https://jet.lc/) in your web browser and install example application.
59-
* Let's start to discover the world of PHP Jet ;-)
31+
# 🚀 Very powerful and safe
6032

61-
### Apache web server
62-
You probably know how to create apache virtual. If not then check [documentation](https://httpd.apache.org/docs/2.4/vhosts/index.html).
33+
PHP Jet is developed by people with experience in banking, telecommunications, e-commerce and so on. So it puts a lot of emphasis on performance and security.
6334

64-
PHP Jet needs nothing more than**mod_rewrite enabled**to run with the Apache web server (see documentation of your system).
6535

66-
And watch out for a possible catch with the necessity to enable [AllowOverride All](https://httpd.apache.org/docs/current/mod/core.html)!
36+
# 👍 Proven by practice
6737

68-
### NGINX web server
69-
If you are not familiar with NGINX server blocks then check out NGINX [documentation](https://www.nginx.com/resources/wiki/start/topics/examples/server_blocks/).
38+
The framework was not developed by theorists, but by people from real practice, by people with decades of experience, by people who are constantly working on specific commercial projects and therefore know the real needs from real practice.
7039

71-
To run Jet (or your projects already built on Jet), it is necessary to create such a server block.
7240

73-
Below you will find an example of how such a server block should look:
41+
# 🤝 Stable
42+
We know how important stability is. We know what it means to be accountable to our clients and users of our software. PHP Jet is already mature and will not change spontaneously. No unpleasant surprises await you.
7443

75-
```
76-
server {
77-
listen 80;
78-
listen [::]:80;
79-
listen 443 ssl;
80-
listen [::]:443 ssl;
81-
ssl_certificate /etc/ssl/certs/ssl-cert-snakeoil.pem;
82-
ssl_certificate_key /etc/ssl/private/ssl-cert-snakeoil.key;
8344

84-
server_name jet.lc;
85-
root /home/user/projects/Jet;
45+
# [For a quick introduction to PHP Jet, click here](https://www.php-jet.net/getting-started/)
8646

87-
index index.html;
88-
89-
location ~ /\.ht {
90-
deny all;
91-
}
92-
93-
location ~ ^/(css|js|images)/ {
94-
try_files $uri $uri/ =404;
95-
}
96-
location / {
97-
include fastcgi_params;
98-
fastcgi_param SCRIPT_FILENAME $document_root/application/bootstrap.php;
99-
fastcgi_pass unix:/var/run/php/php8.0-fpm.sock;
100-
}
101-
102-
103-
location ~ ^/_tools/studio/(css|js|images)/ {
104-
try_files $uri $uri/ =404;
105-
}
106-
location /_tools/studio/ {
107-
include fastcgi_params;
108-
include snippets/fastcgi-php.conf;
109-
fastcgi_pass unix:/var/run/php/php8.0-fpm.sock;
110-
}
111-
}
112-
```
113-
114-
Notes on the NGINX "server block":
115-
116-
* Of course, you need to set the server_name and root parameters according to the situation on your computer.
117-
* An example includes the use of SSL certificates intended for local testing offered by NGINX itself. Of course, these must not be used in a production environment.
118-
* The "location" related to the Jet Studio tool (/_tools/studio/) **should not exist at all on a production server** as well as the tool itself.
47+
![Promo image](images/promo.png "PHP Jet")

0 commit comments

Comments
 (0)