Skip to content

Commit

Permalink
Merge pull request #2 from muonlineph/feat/weaponsforge-1
Browse files Browse the repository at this point in the history
feat: code cleanup
  • Loading branch information
weaponsforge authored Oct 6, 2024
2 parents 24dad1a + de17c75 commit d3b6bae
Show file tree
Hide file tree
Showing 6 changed files with 102 additions and 4,808 deletions.
24 changes: 24 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Deploy to Production Environment

on:
release:
types: [published]

jobs:
deploy-client:
name: Build and Deploy GitHub Pages
if: github.event.release.target_commitish == 'master'
runs-on: ubuntu-latest
steps:
- name: Checkout the repository
uses: actions/checkout@v3
with:
ref: ${{ github.event.release.tag_name }}
- name: List files for publish
run: cd public && ls -l -a
- name: Deploy to Github Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: public
publish_branch: gh-pages
161 changes: 78 additions & 83 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,83 +1,78 @@
## sigs

This repository is a backup and archive of the Mu Online forums signatures request page, created on 2008-2009.

The original website was hosted on Google Sites, Free Webs, and Photobucket before the services shut down or changed their free hosting policies.

The animated GIFs and large reference graphics files are now hosted on Firebase Storage to save space on GitHub. References to original assets that are still available on Photobucket are retained.

**NOTE:** The original site templates use static files and outdated HTML/JS approaches. Some functionality on various pages may not work on modern browsers.

![screenshot](assets/thumbnail_sigs2.png)

## Demo

https://muonlineph.github.io/sigs/public/

## Assets and Related Files

- local-assets: [ [mirror 1](https://firebasestorage.googleapis.com/v0/b/weaponsforge-demo.appspot.com/o/sigs-request%2Flocal-assets.zip?alt=media&token=9c27b849-8eaa-4ad0-ad1b-e97a2a61f7e1) | [mirror 2](https://drive.google.com/drive/folders/1KdY_BEnuetJ4_Qc5GZcyrSe7oGueP9qC?usp=sharing) ]

### Content

- [Demo](#demo)
- [Assets and Related Files](#assets-and-related-files)
- [Content](#content)
- [Dependencies](#dependencies)
- [Installation](#installation)
- [Usage](#usage)


### Dependencies

The following dependecies are used for this project. Feel free to experiment using other dependencies and versions.

1. Windows 64-bit OS
2. NodeJS
- node version 12.16.3
- npm version 6.14.4
3. NodeJS modules (installed via npm)
- gulp v.4.0.2
- browser-sync v.2.26.7


## Installation

1. Clone this repository.
`https://gitlab.com/arcsource/web-design/sigs.git`

2. Install dependencies.
`npm install`

3. Download and extract the assets from [mirror 1](https://firebasestorage.googleapis.com/v0/b/weaponsforge-demo.appspot.com/o/sigs-request%2Flocal-assets.zip?alt=media&token=9c27b849-8eaa-4ad0-ad1b-e97a2a61f7e1) or [mirror 2](https://drive.google.com/drive/folders/1D3B-CRLR3iT8PJub1w6vwmqjV9sbxo6V?usp=sharing) for the following directories. These are required when working on `http://localhost:3000/offline/`.
- /public/300x86
- /public/downloads
- /public/files


## Usage

1. Run the localhost static website development environment.
`npm run dev`

2. Edit the existing static files from the **./public** directory and wait for live reload. Your updates will reflect on the web browser.
- `http://localhost:3000/`
Loads assets and media from online storage references on photobucket and firebase storage.
- `http://localhost:3000/offline`
Loads assets and media from public local development environment references.
Download the required files first for the following directories from the [mirror 1](https://firebasestorage.googleapis.com/v0/b/weaponsforge-demo.appspot.com/o/sigs-request%2Flocal-assets.zip?alt=media&token=9c27b849-8eaa-4ad0-ad1b-e97a2a61f7e1) or [mirror 2](https://drive.google.com/drive/folders/1D3B-CRLR3iT8PJub1w6vwmqjV9sbxo6V?usp=sharing) assets backup before proceeding:
- /public/300x86
- /public/downloads
- /public/files

3. To include new static website files on live reload:
- Stop the localhost **dev** server.
- Create your new static (.html, .js, .css) files inside the **./public** directory.
- Re-start the **dev** server.
`npm run dev`

4. Run the production static website (does not use live reload).
`npm run start`

@weaponsforge
20211110
## sigs

This repository is a backup and archive of the Mu Online forums signatures request page, created on 2008-2009.

The original website was hosted on Google Sites, Free Webs, and Photobucket before the services shut down or changed their free hosting policies.

The animated GIFs and large reference graphics files are now hosted on Firebase Storage to save space on GitHub. The website retains references to original assets that are still available on Photobucket.

**NOTE:** The original site templates use static files and outdated HTML/JS approaches. Some functionality on various pages may not work on modern browsers.

![screenshot](assets/thumbnail_sigs2.png)

## Demo

https://muonlineph.github.io/sigs/public/

## Assets and Related Files

- local-assets: [ [mirror 1](https://firebasestorage.googleapis.com/v0/b/weaponsforge-demo.appspot.com/o/sigs-request%2Flocal-assets.zip?alt=media&token=9c27b849-8eaa-4ad0-ad1b-e97a2a61f7e1) | [mirror 2](https://drive.google.com/drive/folders/1KdY_BEnuetJ4_Qc5GZcyrSe7oGueP9qC?usp=sharing) ]

### Content

- [Demo](#demo)
- [Assets and Related Files](#assets-and-related-files)
- [Content](#content)
- [Dependencies](#dependencies)
- [Installation](#installation)
- [Usage](#usage)


### Dependencies

This project has no dependencies since it only contains static website files. Other local web servers that allow the hosting of static files are alternate options for local host development.

- (Optional) Docker<br>
Required to run a Dockerized Node web server for local development

## Installation

1. Clone this repository.<br>
`https://github.com/muonlineph/sigs.git`

2. Pull the local web server image (this requires Docker installed).<br>
`docker pull weaponsforge/livereload-basic:latest`

3. Download and extract the assets from [mirror1](https://firebasestorage.googleapis.com/v0/b/weaponsforge-demo.appspot.com/o/sigs-request%2Flocal-assets.zip?alt=media&token=9c27b849-8eaa-4ad0-ad1b-e97a2a61f7e1) or [mirror2](https://drive.google.com/drive/folders/1D3B-CRLR3iT8PJub1w6vwmqjV9sbxo6V?usp=sharing) for the following directories. These are required when working on `http://localhost:3000/offline/`.
- /public/300x86
- /public/downloads
- /public/files


## Usage

1. Navigate to the project root directory using a terminal, then run the local web server.<br>
`docker run -it --rm -p 3000:3000 -v %cd%\public:/opt/app/public -e IS_DOCKER=true -e USE_POLLING=true weaponsforge/livereload-basic:latest`

2. Load the localhost website at:<br>
`http://localhost:3000`

3. Edit the existing static files from the **./public** directory and wait for live reload. Your updates will reflect on the web browser.
- `http://localhost:3000/`
- Loads assets and media from online storage references on Photobucket and Firebase Storage
- `http://localhost:3000/offline`
- Loads assets and media from public local development environment references
- Download the required files first for the following directories from the [mirror1](https://firebasestorage.googleapis.com/v0/b/weaponsforge-demo.appspot.com/o/sigs-request%2Flocal-assets.zip?alt=media&token=9c27b849-8eaa-4ad0-ad1b-e97a2a61f7e1) or [mirror2](https://drive.google.com/drive/folders/1D3B-CRLR3iT8PJub1w6vwmqjV9sbxo6V?usp=sharing) assets backup before proceeding:

```
/public/300x86
/public/downloads
/public/files
```

3. To include new static website files on live reload:
- Create new static (.html, .js, .css) files inside the **./public** directory.

@weaponsforge<br>
20211110<br>
20241006
24 changes: 0 additions & 24 deletions gulpfile.js

This file was deleted.

Loading

0 comments on commit d3b6bae

Please sign in to comment.