README.md

HullCSS Site - Eleventy Rewrite

Eleventy rewrite of hullcss.org using the JET template

Transferring main files e.g. posts and rewriting the css to be eleventy and tailwind compliant.

• HullCSS Site - Eleventy Rewrite
  • Development
  • Dockerfile
    • Ouroboros
  • Repo structure
  • Changelog
  • Contributing
  • License
  • Credits

Development

Manual

• clone the repo
• run npm i to install dependencies
• npm run dev
• make some changes and watch them update in the browser.

Docker

the site can also be built and ran inside a docker container when you are in the base of the repo:

• sudo docker build -t hullcss .
• sudo docker run -it -d -p unused-port-number:80 hullcss
• visit localhost:port or ip:port if you are hosting on a VPS and the site should be available to view

Dockerfile

FROM node:latest as npmpackages
WORKDIR /app
COPY package.json .
RUN npm install

FROM node:latest as builder
WORKDIR /app
COPY --from=npmpackages /app /app
COPY . .
RUN npm run build 

FROM nginx:1.17.10-alpine
RUN rm -r /usr/share/nginx/html/
COPY --from=builder /app/public/ /usr/share/nginx/html/

Ouroboros

Using a tool like Ouroboros, you can automatically update containers without the need for restarts. This site is setup with that so you can (instead of building it yourself like above) with sudo docker run -d -p unused-port-number:80 crimsontome427:hullcss

Repo structure

This is not an exhaustive list of files and directories, just some that may be of importance. This will be updated every now and then

.github/ - files involved in github functions
src/
    _includes/ - page templates
    css/ - styling
    feed/ - contains feed imformation
    img/ - where images are stored
    pages/ - where all the non-home pages live
    index.html - site homepage
.gitginore - tells Git what to not add to commits
Dockerfile - tells Docker how it should make the container
LICENSE - what you can and cannot do with the code
package.json - contains information about the repo, npm scripts and packages
README.md - you are reading this
SECURITY.md - what to do if you find a security issue in ths repo
tailwind.config.js - tailwind config file
TODO.md - keeping track of tasks to complete
changelog - updates the changelog file with git log formatted
CHANGELOG.md - commit logs in a nicer format

Changelog

Run ./changelog to generate the changelog after your commit, then git add . && git commit --amend --no-edit to generate the changelog
The changelog is available here

Contributing

Please see the contributing guide

License

hullcss-site-jet is released under the MIT License. The full license text is included in the LICENSE file in this repository. Tldr legal have a great summary of the license if you're interested.

Credits

Original repo is here

Original authors are the University of Hull Computer Science Society and contributors, including Kieran Robson and Nathaniel Read