Template Github Portfolio Website

A modular template github page to showcase project details and images to interested users.

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

• Requires a Github user account, and github page settings turned on. Please read the Deployment Section for instructions on setting this up.
• Node version > 12
• Gulp 4.0
• Ruby 2.7
• (Optional) Rbenv > 1.1

Installing

Please follow the respective software package installation instructions from the source:

• Node
• Gulp
• Rbenv for Ruby

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running

The project is developed by running gulp tasks to compile, minimize, and create assets files for local development and github deployment.

File structure

Explain what these tests test and why

Give an example

Data binding

config.yml

data

includes

Using Gulp

The _site folder is used to locally store changes to the project and create the server from. The assets folder is what the Github Jekyll framework will use to access resources.

# build files into assets and _site folder
gulp build

# watch for changes
gulp

Deployment

Please review Github's step-by-step guidline on setting up a github page, and using Jekyll's static-site generator framework for deploying custom sites to your personal repo. An FAQ on Github's setup with Jekyll can be found here.

Note the distinction between a personal github page, a repository github page, and a github wiki. Guidelines for each can be found here:

• Github page - publish to your https://<username>.github.io/
• Repository github page - publish on your local repository, created a named branch gh-pages
• Github wiki - wiki pages can be made for all github projects, not for webhosting.

Built With

From-end tools

• Github Pages - Used to host
• HTM5, CSS3, and SCSS - Front-end web technology
• Jekyll - Framework to render site on github
• Gulp 4 - Development framework to build locally
• VSCode - Popular IDE that was developed on

Conventions

• BEM - A useful methodology for working with HTML and CSS

Multi-media software

• ffmpeg - converting and compressing videos of all types
• imagemagick - converting image file formats
• Fiji (imageJ) - an frequently used academic software tool used for biological image processing, but has its use in a versatile range of image processing applications.
• illustrator - creating vectorized designs and logos
• photoshop - touching up images
• powerpoint - used to collage images for quick prototyping

Online media resources

• pexels - great resource for free usable images
• unsplash - another great resource for gree and usable images
• coverr - an amazing website with stock cover videos

Scripts

• anaconda
• https://monkeylearn.com/word-cloud/result

Contributing

Please read CONTRIBUTING.md as an example for our code of conduct, coding guidelines, and and the process for submitting pull requests.

Versioning

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

Authors

• George Sun - Main Contributor - Personal Page
• Sun Websites - Host - Company Page

License

This project is licensed under the MIT License - see the LICENSE.md file for details. (Currently under development)

Acknowledgments

Expert HTML5 and CSS3 users who indirectly influenced this work

• Jonas Schmedtman for teaching incredible courses on web technologies. Github page. Website
• Mauricio Urraco for a reference github page to work off from. Reference page. Github page

The community

• A variety of Jekyll and Gulp users who posted their project structure.