Skip to content

A UI testing and development environment for York SU website.

License

Notifications You must be signed in to change notification settings

YUSU-Dev/website

York SU Website Components

Build and Upload to R2 pages-build-deployment Storybook Tests

A UI testing and development environment for York SU website. This repo has two functions, one is to dynamically generate the JS files for our website

Installing

To get started, clone this repo and run npm ci. To use Storybook, run npm run storybook.

Opinionated conventions used

  • For naming of directories or files we should use kebab-case.
  • Vue files should end .ce.vue

Usage on the York SU Website

Any merges to main on this repo will automatically be deployed to https://assets.yorksu.org (hosted on Cloudflare R2). More information on how to add to the website can be found in storybook

Contributing

We have a couple of resources to help you with contributing.

Need Help?

Looking to add this on your website and don't know where to start? Reach out to us on the SU Digital CoP. We can also develop components for your own website in your branding reach out to us on the SU Digital CoP or email us on it@yorksu.org to discuss pricing.

Security

If you've found a vulnerability, we want to know so that we can fix it. Our security policy tells you how to do this.

License

Copyright © 2024 University of York Students' Union

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the License.