Giter Club home page Giter Club logo

shad-news's Introduction

SHAD @ Mac News Website

Hey there! This is the GitHub project for the SHAD @ Mac News team. It features a robust headline system, news updates, a picture of the day, and other information. It was used at SHAD @ McMaster 2016 Campus, by the SHAD @ Mac News team. The site was primarily designed by Matthew Wang (@malsf21).

This website was built with Jekyll, Bootstrap, Font Awesome, and other web technologies in combination with those core elements.

Setup

Setup is pretty easy:

Want to run your own copy of this jekyll site? No problem. You'll need a few things:

  • Ruby, to install Jekyll
  • Jekyll, to build and run the website
  • Git, to clone this repository
  • A Browser, to view the website of course!

First things first, we need to install Jekyll. We assume that you have Git and Ruby installed. If you don't, please visit the links above to install them. We also assume you're using a Unix-based system; if you aren't, follow jekyll's alternatives instruction page.

Type in your command line:

gem install jekyll

After Jekyll completes its setup, clone the git repository:

git clone https://github.com/malsf21/shad-news.git

Then, cd into the repository:

cd shad-news

Inside the repository, all you'll need to do is "serve" the site. Type the following into your command line:

jekyll serve

After that, you should get a response that looks something like this:

jekyll serve
Configuration file: /var/www/html/shad-news/_config.yml
            Source: /var/www/html/shad-news
       Destination: /var/www/html/shad-news/_site
 Incremental build: disabled. Enable with --incremental
      Generating... 
                    done in 0.179 seconds.
 Auto-regeneration: enabled for '/var/www/html/shad-news'
Configuration file: /var/www/html/shad-news/_config.yml
    Server address: http://127.0.0.1:4000/shadnews/
  Server running... press ctrl-c to stop.

Visit what follows the "Server address:" line (which is normally http://127.0.0.1:4000/shadnews/, but that might change soon)!

And voila! Everything should work for you. If something isn't, please let me know on our issues tracker.

shad-news's People

Contributors

mattxwang avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.