/PoracleWeb

Web Interface add-on to PoracleJS

Primary LanguagePHPGNU Affero General Public License v3.0AGPL-3.0

PoracleWeb

Contributors Forks Stargazers Issues

REQUIRES MYSQL !

This tool is an add-on to PoracleJS

This is a first attempt at creating a Web Inteface to handle alarms configuration in PoracleJS.

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.

PoracleWeb handles:

  • Monsters
  • Raids & Eggs
  • Quests
  • Invasions
  • Lures
  • Nests

Any other suggestions are welcome, please use GitHub Issues for your suggestions.

Prerequisites

Installation

  1. Clone the repo

    git clone https://github.com/bbdoc/PoracleWeb.git

  2. Install NPM packages

    npm install

  3. Copy config_example.php to config.php and adapt to your needs

  4. Have a Web Server pointing to your install directory (This tool doesn't include any standalone WebServer)

  5. You will need to configure your some basic settings in config.php:

  • Access Parameters to your Poracle DB
  • Admin ID. From discord, right click on your avatar and use "Copy ID". This defines the ID of the administrator who will be able to perform further configuration tasks.
  • Discord Bot. 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.

For those parameters go to :

  • Discord application Portal
  • Select your Bot (or create a new one).
  • Go to OAuth2 and add your https://yourdomain.com/discord_auth.php (https://yourdomain.com) being your redirect_url
  • Client ID can be found under "General Information"
  • Client Secret can be found under "General Information" by clicking the "Click to reveal" link.A
  1. Go to your PoracleWeb site and head to Admin Tools / Server Settings for additional configuration steps and parameters. You need to be logged in as an admin (as defined by admin_id par ameter to be able to access this page.

Contributing

  1. Fork the Project
  2. Clone your forked project
git clone https://github.com/YourUserName/PoracleWeb.git
  1. Create your New Feature branch (git checkout -b new_feature)
  2. Create a new remote for the upstream repo with the command:
git remote add upstream https://github.com/bbdoc/PoracleWeb
  1. Commit your Changes
git commit -m 'Add some New Feature'
  1. Push to the Branch
git push origin new_feature