Skip to content

Latest commit

 

History

History
26 lines (15 loc) · 1.09 KB

README.md

File metadata and controls

26 lines (15 loc) · 1.09 KB

ps2alerts/website

This module is the publicly facing section of the PS2Alerts project. Users are able to visit the site and read the statistics metrics on a per-alert or global basis and much more.

If you wish to contribute, please join our Discord located at: https://discord.gg/7xF65ap

Running the module

Please see the ps2alerts/stack repository for information on how to install the dev environment and start this project.

This module uses Nuxt, a JavaScript frontend Framework built on Vue 2, with Typescript support. We use this for various reasons, in particular Server Side Rendering (for SEO) and various other rich plugins.

TL;DR

When you first clone make sure to run git submodule update --init --recursive so you can setup the ps2alerts-constants submodule

Run ps2alerts-website-init on first run. For any subsequent starts, run ps2alerts-website-dev.

Technologies

The project currently uses the following projects:

  • Vue 2 via Nuxt (originally Vue 3 but it's not mature enough yet to use)
  • Typescript
  • SCSS
  • NPM