2021-06-13 08:39:20 -07:00
[<img src="phpBB/styles/all/imgs/svg/phpbb_logo_large_cosmic.svg" alt="phpBB" style="max-width:40%" width="400"> ](https://www.phpbb.com )
2010-11-23 22:10:07 +01:00
2016-03-28 09:49:42 -07:00
phpBB is a free open-source bulletin board written in PHP.
2010-11-23 22:10:07 +01:00
2020-10-01 17:09:43 -07:00
## 🧑🏻🤝🏻🧑🏽 Community
2020-10-01 23:36:25 -07:00
Get your copy of phpBB, find support and lots more on [phpBB.com ](https://www.phpbb.com ). Discuss the development on [area51 ](https://area51.phpbb.com/phpBB/index.php ).
2010-11-23 22:10:07 +01:00
2020-10-01 17:09:43 -07:00
## 👨💻 Contribute
2010-11-23 22:10:07 +01:00
2020-10-01 17:09:43 -07:00
1. [Create an account on phpBB.com ](https://www.phpbb.com/community/ucp.php?mode=register )
2. [Create a ticket (unless there already is one) ](https://tracker.phpbb.com/secure/CreateIssue!default.jspa )
3. Read our [Coding guidelines ](https://area51.phpbb.com/docs/dev/development/coding_guidelines.html ) and [Git Contribution Guidelines ](https://area51.phpbb.com/docs/dev/development/git.html )
4. Send us a pull request
2012-03-30 12:59:37 +01:00
2020-10-01 17:09:43 -07:00
### 🏗️ Setting up a development build of phpBB
2012-03-30 12:59:37 +01:00
2020-10-01 17:09:43 -07:00
To run an installation from the repo (and not from a pre-built package) on a local server, run the following commands:
2012-03-30 12:59:37 +01:00
2020-10-02 09:42:07 -07:00
- Fork phpbb/phpbb to your GitHub account, then create a local clone of it:
```
git clone https://github.com/your_github_name/phpbb.git
```
- Install phpBB's dependencies (from the root of your phpbb repo):
```
cd phpBB
php ../composer.phar install
```
2012-03-30 12:59:37 +01:00
2022-12-17 03:11:55 +00:00
Alternatively, you can read:
* Our [Vagrant documentation ](phpBB/docs/vagrant.md ) to find out how to use Vagrant to develop and contribute to phpBB.
* Our [GitHub Codespaces documentation ](phpBB/docs/codespaces.md ) to learn about phpBB's cloud-based development environment.
2010-11-23 22:10:07 +01:00
2020-10-02 09:42:07 -07:00
## 📓 Documentation
2016-03-12 11:26:26 -08:00
2020-10-02 09:42:07 -07:00
phpBB's [Development Documentation ](https://area51.phpbb.com/docs/dev/index.html ) contains all the information you'll need to learn about developing for phpBB's core, extensions and automated testing.
2016-03-12 11:26:26 -08:00
2020-10-01 17:09:43 -07:00
## 🔬 Automated Testing
2012-03-21 23:30:56 +00:00
2022-04-15 19:58:42 +08:00
We have unit and functional tests in order to prevent regressions. You can view the bamboo continuous integration [here ](https://bamboo.phpbb.com ) or check our GitHub Actions below:
2014-03-30 00:07:08 -07:00
2022-04-15 19:58:42 +08:00
Branch | Description | GitHub Actions |
2020-12-22 21:13:58 +01:00
------- | ----------- | -------------- |
**master** | Latest development version |  |
**3.3.x** | Development of version 3.3.x |  |
2012-03-21 23:30:56 +00:00
2020-10-01 17:09:43 -07:00
## 📜 License
2010-11-23 22:10:07 +01:00
[GNU General Public License v2 ](http://opensource.org/licenses/gpl-2.0.php )
