Skip to content
Source code for the legendhub website.
JavaScript HTML Python CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
css
python
www
.env_example
.gitignore
LICENSE
README.md
package-lock.json
package.json

README.md

LegendHUB

A resource hub for LegendMUD.

Version v=2.1.0 License

Table of Contents

Not Included

This repo does not include everything that legendhub.org currently accomplishes. You are responsible for setting these systems up if you want them.

The following are not included:

  • Web server config (apache2/nginx)
  • SSL certificate creation/renewal process
  • An automatic mysql backup process
  • A schedule for creating new notifications. The python app only processes the notification queue once before exiting, you are responsible for running it on a schedule.
  • A connection to the sql database is not provided, though the backup for a mysql database is included and can be used to host your own database (accounts and their settings are not included in this backup - new accounts will need to be created).

Installation

This repo contains a simple to use install process which assumes you have an HTTP server setup on that system.

  • Download and install Node.js - Used for installing dependencies.
  • Download and install the latest version of Python 3 - Used for the notification process.
  • Clone this repo to your local machine using git clone https://github.com/SvarturH/legendhub.git
  • Navigate to the root directory of the cloned repo and run npm install to install the necessary dependencies.
  • This will create the following file:
    • .env
    • python/sql/sql_engine_config.py
  • Replace the default values in the config files with your sql database information.

Building and Deploying

  • Run npm run build to build all of the projects.
  • To build each project individually run the following commands:
    • npm run build:python
    • npm run build:css
  • Building the css project will copy the new css files to the www directory. This is only necessary if you make changes to the CSS project, as the web project already has the latest CSS.
  • Once everything is built, simply run npm start or npm start-dev to run the project in production or development mode.
  • The project will now be listening on the port provided in the .env file.

Sql Database Backup

  • The latest backup file can be downloaded from here.
  • Use the following command to import the backup:
    • mysql –u[user name] -p[password] -h[hostname] [database name] < [path-to-file].sql
You can’t perform that action at this time.