Skip to content

astroclubiitk/astroclubiitk.github.io

Repository files navigation

Astronomy Club IITK Website

This is the official repo for the homepage of Astronomy Club IIT Kanpur, hosted at https://astro.sntiitk.in/.

Installation

You may want to run the website locally, probably to deep dive into the code, find any bug/issue or contribute to improve the website. The site is served using Jekyll, a Ruby-based static site generator with immense support for GitHub pages. You may need to go through the installation process for the Jekyll depending on your OS. For Ubuntu, the steps are also written here for ease:

  • Install Ruby and other prerequisites:
sudo apt-get install ruby-full build-essential zlib1g-dev 
  • Avoid installing RubyGems packages (called gems) as the root user. Instead, set up a gem installation directory for your user account. The following commands will add environment variables to your ~/.bashrc file (or say ~/.zshrc, depending on your shell) to configure the gem installation path:
echo '# Install Ruby Gems to ~/gems' >> ~/.bashrc
echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc
echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
  • Finally, install Jekyll and Bundler:
gem install jekyll bundler

Now all set, you are ready to clone and start serving the site locally.

  • Clone the repo and move into it
git clone https://github.com/astroclubiitk/astroclubiitk.github.io.git
cd astroclubiitk.github.io
  • Install the dependecies
bundle install
  • Serve the site and head over to localhost:4000
bundle exec jekyll serve --livereload

NOTE:
(i) If you edit _config.yml file, live-reload doesn't work and you need to stop the serving using Ctrl+C and then serve again to see any changes made.
(ii) If using Windows, you might encounter the error, "Unable to load the EventMachine C extension; To use the pure-ruby reactor, require 'em/pure_ruby'". Refer this to resolve it.

Contributors

Name Work Domain
Gurbaaz Singh Nandra Programming
Varun Muralidharan UI/UX
Mohammad Saad Content Writing
Mubashshir Uddin Content Writing
Sunny Kumar Bhagat Content Compilation
Varun Singh Content Compilation

We always welcome an issue or a suggestion!
Also, feel free to contribute via a PR. If deemed worthy, we would be more than happy to incorporate it 😄.

Credits

A big shoutout to Dean Attali, who developed the Beautiful Jekyll theme ❤️. Do check out his account and repositories to explore other cool stuff!