README.md

Sluggo-SPA

The single-page-application frontend for Sluggo written in Vue.js and TypeScript.

Project setup

nvm setup (optional)

nvm install --lts
nvm use --lts

Install packages

yarn

Run the Application

When setting up the project, be sure to do the following:

• Run the SluggoAPI server (available from https://github.com/Sluggo-Issue-Tracker/Sluggo-API)
• Set an environment variable VUE_ROOT for the API to point to the SPA address (for devel, do http://localhost:8080). This is required to allow server-sided auth to run correctly.

Then run:

yarn run serve

You may access the SPA instance from http://localhost:8080 in your browser.

Be sure to use this address, using 127.0.0.1:8080 will result in errors.

Ideally, this will be privately configurable later.

Compiles and minifies for production

yarn run build

Run your unit tests

yarn run test

Lints and fixes files

yarn run lint

Customize configuration

See Configuration Reference.

Key Technologies

• node v14.17.5
• Sluggo-API
• Boxicons (icon pack)
• Bulma (CSS framework)
• Vue v3

License

This project is licensed under the Apache 2.0 License. See LICENSE for details.