Skip to content

Commit

Permalink
Merge pull request #15 from iMattPro/minor
Browse files Browse the repository at this point in the history
Minor update
  • Loading branch information
iMattPro authored Jan 5, 2024
2 parents d25a683 + 4c5a405 commit 1924324
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,25 @@ An official phpBB extension that allows board users to receive browser-based pus

Please fork this repository and submit a pull request to contribute to this extension.

To run this extension from the repo (and not from a pre-built package) on a local server, perform the following tasks:

- Fork phpbb-extensions/webpushnotifications to your GitHub account, then create a local clone of it:
```bash
git clone https://github.com/your_github_name/webpushnotifications.git
```
- Install this extension's dependencies (from the root of your webpushnotifications repo):
```bash
cd webpushnotifications # navigate into the root of your webpushnotifications repo
php composer.phar install # installs extension's 3rd-party dependencies
```
- Install the extension to your local phpBB forum by moving your local repo to the proper phpBB directory:
```bash
cd ../ # back out one directory level
mv webpushnotifications path_to_phpBB/ext/phpbb # move webpushnotifications to your phpBB/ext/phpbb directory
cd path_to_phpBB # navigate to your phpBB forum's root directory
php bin/phpbbcli.php extension:enable phpbb/webpushnotifications # install the extension
```

## License

[GNU General Public License v2](license.txt)

0 comments on commit 1924324

Please sign in to comment.