Before playing around with this website you need to understand how everything fits together. The website itself is a single Vue application. The Vue application is loaded in the app/application.js file and the app/Application.vue component is used to render the application. Webpack is used to bundle everything together (the how is defined in the webpack.config.js file) as well as to create a development server with livereload (using the npm run dev command). Deployment is very simple: everything inside the public folder after npm run build has been executed needs to be published. In our case, this is done by using GitHub Actions and GitHub Pages.
Changes should be made in the source branch.
- Clone this repository using git:
git clone https://github.com/hacksurrey/mk2.git - Install all Node dependencies using NPM (whilst I adore Yarn, I chose not to use it for this project):
npm install - Start the development server using Node and NPM:
npm run dev - That's it! If everything has been done correctly, Node has now started a development server (usually on
localhost:8080) and has also opened your browser to this location. Have fun and don't break anything! 🎉