mc-landing's Introduction

MC Landing

A landing page for the RAk3rman Minecraft server network. Built on the base-webframework-nodejs template, a general template for a nodejs web application running express

Basic Structure

This project is a base web framework to run a web application using express through NodeJS. Being a 'base' framework, this project only displays a webpage through a specified port with no authentication. The structure of this application is described below in the application map.

Application Map

--app.js # Primary NodeJS file
--routes # Routes for views
  --mainRoutes.js
--views # Components of webpage, HTML
  --pages
    --home.ejs # Home Page
    --error.ejs # Error Page
--config # Folder where configurations are set
  --exitOpt.js # Exit options when running in testing environment
  --sysConfig.json # Appears upon system configuration within application
--static # Place static files to be accessed by webpage here
--package.json # NPM 
--package-lock.json
--start.sh
--LICENSE
--README.md
--.travis.yml
--.gitignore

Install and Setup

Clone the repository from github.com

git clone https://github.com/RAK3RMAN/mc-landing.git

Setup MC Landing
- Enter the mc-landing folder
  - cd mc-landing
- Install all required packages with root-level access (if needed)
  - sudo npm install
- Start default application using npm
  - npm start
- If you want a different broadcast port, you can configure these values by proceeding with the:
  - Hardcode option:
    - Enter the sysConfig.json file
      - sudo nano mc-landing/config/sysConfig.json
    - Edit the console_port parameter to your desired configuration
- If any errors occur, please read the logs and attempt to resolve. If resolution cannot be achieved, post in the issues under this project.
Access web application through localhost:3000

Recommend Projects