Skip to content

geeksforsocialchange/gfsc-v3

Repository files navigation

Geeks for Social Change

New site build for Geeks for Social Change using Hugo static site generator.

Previous site was made with Jekyll.

The new site will use Hugo, and feature a redesign as well as new and updated content.

Development

Prerequisites

  • Git
  • Github account if you would like to make pull requests
  • Hugo we are using hugo_extended_0.111.3 available for download here or consult the official documentation. The Hugo API changes enough that it's recommended to download this version to the project directory.
  • node

Setup & install instructions

git clone https://github.com/geeksforsocialchange/gfsc-v3.git && cd gfsc-v3

hugo server for a local server - you will be able to access the site at localhost:1313.

If you need test the site on multiple devices locally you can bind the address to your local IP, you can then run the command below replacing the IP address.

hugo server --bind 192.168.10.10 --baseURL http://192.168.10.10

You would then visit (example IP) 192.168.10.10:1313

Formatting

To set up our pre-commit hook for formatting you will need to run the following

npm i
npm run prepare

Build

hugo command to build. This will create a directory called public which contains the website.

Deployment

Deploys to cloudflare.

When a change is committed to the main branch the site is rebuilt and deployed.

Development

When a pull request is created, a preview site is deployed. Cloudflares github app will add a comment to pull requests with the url to this preview when changes are made to the relevant branch. Due to an issue with the bot if are opening a pull request on a branch that has already been built by cloudflare there will be no comment but you can still access the preview by adding the branch name to the front of cloudflare pages URL.

https://[branch-name].gfsc.pages.dev

If the build is successful and the changes are approved it can be merged into main which will automatically deploy it.

## Testing

To check if links are working and images have alt text, you can use htmltest. To install it run curl https://htmltest.wjdp.uk | bash. From now on you can run hugo and then bin/htmltest to use.

License

Contributing

Donations