Project Site | https://projects.michaelbateman.ca

For more information on this project, visit this project on my projects website at https://projects.michaelbateman.ca/projects-website/

About

This website has all of Michael's computer science projects.

Note: According to the linguist language filters, it shows that most of my project was written in HTML. However, this is incorrect, so you might notice the .gitattributes file. That file changes the filter to show Ruby instead.

If you want to setup your own site using this site as a template, please go to https://projects.michaelbateman.ca/setup.html.

Future Improvements

This website currently has a lot of functionality and is easy to maintain, but there are still some things that can be done and improved. Please look at the list below, on how this project can be improved.

• Easier website management

If you have suggestions and/or ideas, please either fork this repository using the instructions below, or submit an issue.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Note: This guide assumes your on a Unix machine

Prerequisites

To run my website you will need the following things:

1. Git
2. Ruby
3. Jekyll

Below, shows how to install each of these.

Installation

Please follow these instructions exactly so you don't run into any errors.

Git

All modern Mac's come with Git preinstalled. If you're using an older Mac or you do not have Git installed, please follow instructions on their website (https://git-scm.com). You will need Git to clone the repository.

Ruby

Ruby also comes preinstalled on modern Mac's! If you do not have it, please follow instructions on their website (https://rubygems.org). You will need Ruby to install Jekyll.

Jekyll

Jekyll is a static site generator that is needed to build and run the website. We will install Jekyll using Ruby. Unfortunately, Jekyll is not preinstalled on Mac's, but it is very simple to setup.

Note: The $ is to remind that this is the command line. When entering prompts, you do not include the $.

• Open Terminal.app to access the command line. You should see something like this:

Last login: Tue Feb 14 16:39:48 on ttys000
Michaels-MacBook-Pro-Retina:~ michaelbateman$ 

• Now, install Jekyll by typing:

$ gem install jekyll

Jekyll is now all installed!

Clone

Now, we need to use Git to clone our repository.

• Clone the repository with HTTPS

$ git clone https://github.com/michael-bateman/projects.michaelbateman.ca

• Navigate into the directory by typing:

$ cd projects.michaelbateman.ca/

• Now to start the website, type:

$ jekyll serve

Once the website is being served, you should see something like this:

Configuration file: /Users/michaelbateman/Documents/uccewb-website/_config.yml
Configuration file: /Users/michaelbateman/Documents/uccewb-website/_config.yml
            Source: /Users/michaelbateman/Documents/uccewb-website
       Destination: /Users/michaelbateman/Documents/uccewb-website/_site
 Incremental build: disabled. Enable with --incremental
      Generating... 
                    done in 0.76 seconds.
 Auto-regeneration: enabled for '/Users/michaelbateman/Documents/uccewb-website'
Configuration file: /Users/michaelbateman/Documents/uccewb-website/_config.yml
    Server address: http://127.0.0.1:4000/
  Server running... press ctrl-c to stop.

You should now be able to access the site by going to http://localhost:4000

By default, Jekyll will serve the website on port 4000 which can get annoying if you are working on multiple projects and want to serve them all at the same time. You can type the following to serve it on another port:

$ jekyll serve --port 80

Note: If you select port 80, you do not need to type in the port number, so instead you type http://localhost/.

If the following message appears when trying to bind on a different port, you will need to use the sudo command.

jekyll 3.3.1 | Error:  Permission denied - bind(2) for 127.0.0.1:80

You now need to type:

$ sudo jekyll serve --port 80

Built With

• Sublime Text - The text editor
• Bootstrap - The CSS framework
• Jekyll - Static site generator

Authors

• Michael Bateman - GitHub

See the list of contributors who helped in this project.

License

This project is licensed under the MIT license - see the LICENSE.md file for more details.

Acknowledgments

• README.md template - PurpleBooth