How to run this website locally ?

  1. Install Jekyll using this link. Detailed instructions are given under "Guides" (Use Ruby version 2.7, later versions may give some errors with the Jekyll dependencies)
    • Note: If you are installing Jekyll to WSL Ubuntu, choose "Ubuntu"from the above link.
    • TLDR; run these command in order on Ubuntu or WSL Ubuntu
    •                     
      sudo apt update ;
      sudo apt-get install ruby-full build-essential zlib1g-dev ;
      echo '# Install Ruby Gems to ~/gems' >> ~/.bashrc ;
      echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc ;
      echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc ;
      source ~/.bashrc ;
      gem install jekyll bundler ;
      
  2. Create a fork of the repository
    • Login to GitHub
    • Go to the GitHub Repo of this site
    • Click Fork
    • Copy the link from your forked repo

  3. Clone your forked repository of this site,
    • For WSL Ubuntu, SHIFT+RightClick inside any folder. Click "Open linux shell here"
    • git clone **your copied URL here**
      • Example,
        git clone https://github.com/myGitHubUsername/Undergraduate-Courses.git
    • cd Undergraduate-Courses

  4. Install plugins for Jekyll
    • bundle install
  5. Start the webserver
    • bundle exec jekyll serve
    • Note: On WSL you may need to add these options
      • bundle exec jekyll serve --livereload --force_polling
  6. Open the link given in the command line on your webbrowser. It should look like this,

  7. Edit your local files and you can see the output using the above link