Ed Oswald Go's Website

Official Website of Ed Oswald Go

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

1. Command-line Interface

   • For Windows, suggest to use Cmder.
   • For Mac, suggest to use iTerm2.

2. Git - Installation Guide

   • May skip this step if will use Cmder for Windows. Git is included by default.

3. Git Configuration

   ### Open the installed command-line interface and run the
   ### commands below. Please note of the OS-specific configuration.
   
   ## General Settings
   $ git config --global user.name "John Doe"
   $ git config --global user.email "github@email.com"
   $ git config --global push.default simple
   $ git config --global fetch.prune true
   
   ## Windows-specific Settings
   $ git config --global core.autocrlf true
   
   ## Mac / Linux-specific Settings
   $ git config --global core.autocrlf input
   

4. Ruby - Installation Guide

5. Jekyll - Installation Guide

   ### Open the installed command-line interface and run the commands below.
   $ gem install jekyll bundler
   
   ## Check if Jekyll is installed
   $ jekyll -v 
   
   ## Go to any temporary directory and create a new Jekyll project.
   ## Note: This step will be executed in order to install Jekyll-related Gems.
   $ cd <some directory>
   $ jekyll new <project name>
   $ cd <project name>
   
   ## This will build the default static website and may view it at http://localhost:4000
   $ jekyll serve
   
   ## Note: May delete the project created once done experimenting.
   

6. Text Editor / IDE

   • Any editors will do but suggest to try out Visual Studio Code for coding and creating Markdown contents.

     • VSC Extension Recommendations:
     • https://github.com/viatsko/awesome-vscode
     • http://www.hongkiat.com/blog/visual-studio-code-extensions/
     • https://stackify.com/top-visual-studio-code-extensions/
     • https://tutorialzine.com/2017/06/15-essential-plugins-for-visual-studio-code

Installing

A step by step series of examples that tell you have to get a development env running

Clone the GitHub Project

$ cd <desired workspace directory>
$ git clone https://github.com/edoswaldgo/edoswaldgo.github.io.git

Go to the project directory

$ cd edoswaldgo.github.io

Run the Jekyll server

$ jekyll serve --watch

## Note: the `watch` flag checks for file changes and rebuilds the site automatically.
## But, when changing the `_config.yml` file, there's a need to restart Jekyll.

May now open the web browser and go to http://localhost:4000 to view the website.

Project Structure

Please read Jekyll's Directory Structure for detailed directory structure reference.

Deployment

Upon pushing changes to GitHub via the master branch, GitHub will automatically publish the changes and update the website.

Built With

• Minimal Mistakes - The Jekyll theme used

Contributing

Currently, the project is not open for accepting pull requests except for the project team members.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Ed Oswald Go - GitHub

License

See the LICENSE.md file for details.

Acknowledgments

• TBD