Skip to content

Latest commit

 

History

History
55 lines (32 loc) · 2.62 KB

README.md

File metadata and controls

55 lines (32 loc) · 2.62 KB

Class of 2020 Website

The site is open source (here's all the code!).

Submit issues and pull requests for stories, site ideas or copy edits.

Goals

  • Demystify open source terminology
  • Showcase the class members to promote connections and sharing between individuals
  • Starting with git and GitHub
  • Whatever best, you can think off

Under the Hood

This site is made with Jekyll, an open source static site generator. This means the Jekyll program takes the content we want to be on the site and turns them into HTML files ready to be hosted somewhere. Awesomely, GitHub provides free web hosting for repositories, called GitHub Pages, and that's how this site is hosted.

Contributing

Fix/Edit Content

If you see an error or a place where content should be improved or updated, just fork this repository to your account, make the change you'd like and then submit a pull request. If you're not able to make the change, file an issue.

Add Member to the Class

If you know of a person that should be added to the member list that generates the matrix of avatars on the Class page: fork this repository, open the _class/_TEMPLATE.md file and follow the instructions therein carefully. Commit your change, git push and submit a pull request!

To Set up Locally

You can take all the files of this site and run them 'just' on your computer as if it were live online, only it's just on your machine.

Requirements

Should you face any problem, feel free to ping Ashish or Nischal.

To copy the repository's files from here onto your computer and to view and serve those files locally, at your computer's command line type:

git clone https://github.com/Classof2020/classof2020.github.io.git
cd classof2020.github.io
bundle install
jekyll serve

Open http://localhost:4000 in your browser

Issues

Feel free to make a pull request for fixes and improvements to current website. For questions or problems on this repo come talk to us via the NCIT SE 2016 group chat on Facebook or open up an issue, we'll do our best to help you out.