Git will be used to install the project folder. Note that while downloading via zip file may work, Git is the preferred option. For installation via ZIP archive, view Installation via ZIP below.

1. Git
2. Jekyll
3. Node.js
4. Yarn

git clone https://github.com/buildingblocs/2022.git

git clone [email protected]:buildingblocs/2022.git

gh repo clone buildingblocs/2022

Download the ZIP archive and extract it to a folder. This folder will now be your working directory. Simply open this folder in your favourite code editor and get working!

Yarn is the selected package manager for our project. Run yarn install to install all project dependencies.

yarn install

Only required if you are modifying stylesheets. Start grunt (tool to build .scss to .css) and make it watch for file changes:

yarn build watch

If you want to just build and exit, do:

yarn build

yarn upgrade --latest --caret

yarn upgrade --latest

Jekyll is used to run a localised version of the website, that allows you to easily view the changes you make. Run jekyll serve in your project folder and type http://localhost:4000 into your web browser of choice to view the website.

jekyll serve

Visit the Jekyll docs for more information on the directory structure.

We strongly encourage local development and making pull requests as editing via the online environment could be messy and hard to organise. Thank you!

To submit your changes, please either commit changes to a different branch or fork the repo and Create a Pull Request. Use the template in the .template folder for making a Pull Request.

To make this the site that visiting buildingblocs.sg redirects to, see this repo.

This server uses SASS, hence the .scss files can be found at /assets/sass/