Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 1.54 KB

README.md

File metadata and controls

43 lines (28 loc) · 1.54 KB
Raw

SpongeDownloads

The downloads page for the Sponge project, using System Of A Download as the data source for the download lists.

Development

SpongeDownloads is a single-page application (SPA) built using Vue.js, currently version 2.6.

To set up your workspace, ensure you have the following installed:

  • Node.js version 16 (at the time of writing, v16.20.0 was in use); and
  • npm v8.1 or later.

Clone this repository, navigate to the root directory in your favourite shell and run npm i.

Building

SpongeDownloads is built with vue-cli 4. To build the production page to the dist folder, run:

npm run build

This will produce a production version of SpongeDownloads, which by default, will point at the SOAD staging server, assumes a public path of /downloads and generates a file called index.html as the entry point to the application. You can set the following environment variables in your shell prior to building to change these values:

  • VUE_APP_PUBLIC_PATH: set the public path
  • VUE_APP_API_URL: set the API URL to point to
  • VUE_APP_INDEX_PATH: set the name of the HTML page that is generated

Testing locally

To start the development server at http://localhost:8080/downloads, run:

npm run serve

To check the code for errors using ESLint, run:

npm run lint