Skip to content

NewcastleRSE/rse-admin-webapp

Repository files navigation

RSE Admin - Web App

A VueJS based SPA for the RSE Admin Tool

About

The RSE Admin tool is for tracking the assignment of RSEs to projects, cost recovery and project status. The app brings together data from HubSpot, University financial reports and assignment data from the API.

Project Team

Mark Turner, Newcastle University ([email protected])
Kate Court, Newcastle University ([email protected])
Becky Osselton, Newcastle University ([email protected])

RSE Contact

Mark Turner
RSE Team
Newcastle University
([email protected])

Built With

The application uses Vue to manage routes and daa binding, with Vuex for state management. Charts are implemented with HighCharts and layout uses TailwindCCS.

VueJS
Vuex
HighCharts
Tailwind

Getting Started

Prerequisites

A local version of NodeJS (nvm is recommended) and a local MySQL Community Server running for development. Whilst possible to interact with the database via an interactive shell, it is recommended to use a GUI tool such as MySQL Workbench.

Installation

Install dependencies

yarn install

Running Locally

Run with hot reload for development

yarn serve

If using Node 18 You may need to run this command if yarn serve fails with an 'digital envelope routines::unsupported' error.

export NODE_OPTIONS=--openssl-legacy-provider

or switch to Node 16.

Running Tests

Detect linting errors

yarn lint

Deployment

Local

Deploying to a production style setup but on the local system. Command builds and minifies files into dist folder.

yarn build

Production

Deploying to the production system. Examples of this would include cloud, HPC or virtual machine.

Usage

Any links to production environment, video demos and screenshots.

Roadmap

  • Initial Research
  • Minimum viable product
  • Alpha Release
  • Feature-Complete Release

Contributing

Main Branch

Protected and can only be pushed to via pull requests. Should be considered stable and a representation of production code.

Dev Branch

Should be considered fragile, code should compile and run but features may be prone to errors.

Feature Branches

A branch per feature being worked on.

https://nvie.com/posts/a-successful-git-branching-model/

License

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published