This website is a community website for everyone to be able to contribute to. Tech should be accessible to everyone and everyone should be included in the making of it. This site aims to help break down barriers and allow people to contribute to a project with whatever skills they have.
You can contribute through the browser or from your favourite terminal. Go the contributing guide to learn how.
The site is built using Jekyll, a Ruby application, or Gem.
As such, you'll need Ruby installed (version 2.3.3 or newer).
This guide does include steps for installing Ruby, and other Jekyll dependencies, but you can always refer to Jekyll's own guide here.
To install Ruby on Windows, you can
- Use Chocolatey (a Windows Package Manager)
- Get Chocolatey
- Open Command Prompt or Powershell
> choco install ruby -y
- Download it from RubyInstaller
- Download Ruby + Devkit
- Run the installer
For Ubuntu / Debian-based distributions:
$ sudo apt install ruby ruby-dev build-essential -y
Now that Ruby is installed, installing Jekyll (and other gems) should be platform agnostic.
- ℹ️ you may need to run commands prefixed by
sudoon non-Windows environments. - ℹ️ You may need to logout / restart your terminal window to refresh paths.
Install Jekyll as follows, from a terminal window:
gem install jekyll bundler
To ensure the site has any other gems it depends on installed, make sure you're in the project folder root and run:
bundle update
Now that everything is set up, you can run the site locally.
- Make sure you're in the project folder root and run:
jekyll serve.
- Leave that terminal window open
- Head to your favourite web browser
The local site can be reached here: http://localhost:4000/
Well done, you're up and running! 🎉
Raise a pull request with your changes!