xref: /web-php/README.md (revision 48a89648)
1[![Integrate](https://github.com/php/web-php/actions/workflows/integrate.yaml/badge.svg)](https://github.com/php/web-php/actions/workflows/integrate.yaml)
2
3## Local development
4
5This is the git repository for the official www.php.net website.
6
7To setup a local mirror of the website, clone the repository:
8
9```
10git clone https://github.com/php/web-php.git
11```
12
13Change into `web-php`:
14
15```
16cd web-php
17```
18
19Start the built-in web server:
20
21```
22php -S localhost:8080 .router.php
23```
24
25This repository includes most (generated) files that are required for normal
26operation of this website, such as
27
28 - News & events data
29 - Several manual pages (and a translation), see manual/{en,ja}/
30 - User contributed notes for manual pages
31 - A "router" for the builtin PHP webserver
32
33How to set up a full local mirror is described in our Wiki:
34https://wiki.php.net/web/mirror
35
36## Code requirements
37
38Code must function on a vanilla PHP 8.2 installation.
39Please keep this in mind before filing a pull request.
40
41## Contributing
42
43Please have a look at [`CONTRIBUTING.md`](.github/CONTRIBUTING.md).
44