|
1 | 1 | # PoracleWeb
|
2 | 2 |
|
| 3 | + |
| 4 | +[![Contributors][contributors-shield]][contributors-url] |
| 5 | +[![Forks][forks-shield]][forks-url] |
| 6 | +[![Stargazers][stars-shield]][stars-url] |
| 7 | +[![Issues][issues-shield]][issues-url] |
| 8 | + |
| 9 | +--- |
| 10 | + |
3 | 11 | REQUIRES MYSQL !
|
4 | 12 |
|
5 |
| -This tool is an add-on to PoracleJS (https://github.com/KartulUdus/PoracleJS) |
| 13 | +This tool is an add-on to [PoracleJS](https://github.com/KartulUdus/PoracleJS) |
6 | 14 |
|
7 | 15 | This is a first attempt at creating a Web Inteface to handle alarms configuration in PoracleJS.
|
8 | 16 |
|
9 | 17 | Please note that I'm not a professional Web Developer, so the code might look ugly to some people, but it works. I'm of course open to suggestion on improving the code or adding functionalities.
|
10 | 18 |
|
11 |
| -It currently only handle Monsters / Raids / Eggs Alarms. Quests and Invasions are not supported yet by are planned features. |
| 19 | +--- |
| 20 | + |
| 21 | +**PoracleWeb handles:** (unchecked are planned features) |
| 22 | +- [x] Monsters |
| 23 | +- [x] Raids & Eggs |
| 24 | +- [x] Quests |
| 25 | +- [ ] Invasions |
12 | 26 |
|
13 | 27 | A few other features that might make their way into the tool :
|
14 | 28 |
|
15 | 29 | - Ability to set a Location.
|
16 | 30 | - Ability to set a Distance globally for all Monsters and/or all Raids/Eggs.
|
17 | 31 | - A way to visualize distances drawing a radius on the map from current position.
|
18 | 32 |
|
19 |
| -Any other suggestions are welcome, please use GitHub Issues for your suggestions. |
| 33 | +Any other suggestions are welcome, please use [GitHub Issues][issues-url] for your suggestions. |
| 34 | + |
| 35 | +--- |
| 36 | + |
| 37 | +### Prerequisites |
| 38 | + |
| 39 | +* [NodeJS & NPM](https://nodejs.org/en/download/) |
| 40 | +* [Composer](https://getcomposer.org/download/) |
20 | 41 |
|
21 |
| -To get started with it : |
22 |
| -- As always, copy `config_example.php` to config.php and adapt to your needs |
23 |
| -- Have a Web Server pointing to your install directory (This tool doesn't include any standalone WebServer) |
| 42 | +--- |
24 | 43 |
|
25 |
| -You will need to configure your Discord Bot settings in config.php. If you use PMSF, you can reuse the same parameters for `discordBotClientId` and `discordBotClientSecret` or find them on the Discord application Portal. `redirect_url` should point to your PoracleWeb base directory and should be configured as a Redirects in your Discord bot. |
| 44 | +### Installation |
| 45 | + |
| 46 | +1. Clone the repo |
| 47 | + ```sh |
| 48 | + git clone https://github.com/bbdoc/PoracleWeb.git |
| 49 | + ``` |
| 50 | +2. Install NPM packages |
| 51 | + ```sh |
| 52 | + npm install |
| 53 | + ``` |
| 54 | +3. Copy `config_example.php` to `config.php` and adapt to your needs |
| 55 | +4. Have a Web Server pointing to your install directory (This tool doesn't include any standalone WebServer) |
| 56 | + |
| 57 | +5. You will need to configure your Discord Bot settings in config.php. If you use PMSF, you can reuse the same parameters for `discordBotClientId` and `discordBotClientSecret` or find them on the [Discord application Portal](https://discord.com/developers/applications). `redirect_url` should point to your PoracleWeb base directory and should be configured as a Redirects in your Discord bot. |
26 | 58 |
|
27 | 59 | For those parameters go to :
|
28 |
| -- https://discord.com/developers/applications |
| 60 | +- [Discord application Portal](https://discord.com/developers/applications) |
29 | 61 | - Select your Bot (or create a new one).
|
30 | 62 | - Go to OAuth2 and add your `http://yourdomain.com/discord_auth.php` (`http://yourdomain.com/`) being your `redirect_url`
|
31 | 63 | - Client ID can be found under "General Information"
|
32 | 64 | - Client Secret can be found under "General Information" by clicking the "Click to reveal" link.
|
| 65 | + |
| 66 | +--- |
| 67 | + |
| 68 | +## Contributing |
| 69 | + |
| 70 | +1. Fork the Project |
| 71 | +2. Clone your forked project |
| 72 | +```sh |
| 73 | +git clone https://github.com/YourUserName/PoracleWeb.git |
| 74 | +``` |
| 75 | +3. Create your New Feature branch (`git checkout -b new_feature`) |
| 76 | +4. Create a new remote for the upstream repo with the command: |
| 77 | +```sh |
| 78 | +git remote add upstream https://github.com/bbdoc/PoracleWeb |
| 79 | +``` |
| 80 | +3. Commit your Changes |
| 81 | +```sh |
| 82 | +git commit -m 'Add some New Feature' |
| 83 | +``` |
| 84 | +4. Push to the Branch |
| 85 | +```sh |
| 86 | +git push origin new_feature |
| 87 | +``` |
| 88 | + |
| 89 | +[contributors-shield]: https://img.shields.io/github/contributors/bbdoc/PoracleWeb.svg?style=for-the-badge |
| 90 | +[contributors-url]: https://github.com/bbdoc/PoracleWeb/graphs/contributors |
| 91 | +[forks-shield]: https://img.shields.io/github/forks/bbdoc/PoracleWeb.svg?style=for-the-badge |
| 92 | +[forks-url]: https://github.com/bbdoc/PoracleWeb/network/members |
| 93 | +[stars-shield]: https://img.shields.io/github/stars/bbdoc/PoracleWeb.svg?style=for-the-badge |
| 94 | +[stars-url]: https://github.com/bbdoc/PoracleWeb/stargazers |
| 95 | +[issues-shield]: https://img.shields.io/github/issues/bbdoc/PoracleWeb.svg?style=for-the-badge |
| 96 | +[issues-url]: https://github.com/bbdoc/PoracleWeb/issues |
0 commit comments