The Lancaster University Computer Science Society website frontend.
Make sure to join our Discord server!
Want to contribute? Start by creating an issue (or read any existing ones) so that we can discuss your ideas. We use the GitHub issue tracker to monitor bugs and suggestions for new features.
- Fork the repo on GitHub
- Clone the project to your own machine
- Install the system/project dependencies
- Commit your changes to your own branch
- Push your work back up to your fork
- Submit a Pull request so that we can review your changes
See the setup and development guidance below.
You don't need to learn to use the command line version of Git straight away, but it's good to know how it works!
- Node.js v12 - JavaScript runtime
- yarn - node package manager
- Docker Desktop (to run tests in the server environment)
We use Docker containers so that we can test our code in an environment as close to production as possible. No more "It works on my machine!". You should run tests on your code before submitting a pull request.
Need help to install these? We can point you in the right direction in our Discord server!
- Vue.js 2.x (v3 was recently released, but Vuetify hasn't been updated yet)
- Vuetify - design framework
You will need the Vue CLI to build and run the website locally. This can be installed using the following command:
➜ yarn global add @vue/cli
Make sure to install the system and project dependencies above before getting started.
Next, clone your fork of the repository to your own machine and install the package dependencies.
➜ git clone https://github.com/<username>/www lucompsoc-www
➜ cd lucompsoc-www
➜ yarn (or yarn install if you want to be verbose)
Now you can check everything is working properly by starting the local development server:
➜ yarn serve
yarn run v1.22.5
$ vue-cli-service serve
INFO Starting development server...
DONE Compiled successfully in 6983ms
App running at:
- Local: http://localhost:8080/
You should now be able to see the website if you open http://localhost:8080/ in your browser!
TBD