glixer

glixer

Blog, Portfolio & Website framework for Github Pages

Glixer - GitHub Pages, Gulp, Jekyll, SCSS, Bootstrap.

Blog, Portfolio & Website framework.

Why?

  1. EASY to use and Quick to get started.
  2. Nothing else does this.

People new to web developement and working professionals often do not have the knowledge or time to know which tools they should be using or the know-how to configure them.

This project is meant to be a jump start for people in both groups.

Demo

View this jekyll theme in action here

Built with:

The tools listed above are included with this package and are ready to go once this package is installed.

Getting Started

C9

Setup

  1. Logon to Github
  2. Fork this repository
  3. Copy your fork url e.g. [email protected]:YOURUSERNAME/glixer
  4. On c9.io create a new workspace
    • Template: Blank (Ubuntu Logo)
    • Clone from Git: use your fork url here
  5. When you get redirected to some sort of environment, look at the bottom, that's your command line. Click on it and enter the following command: node glixer.js init

Operation

To view the work:

  1. In the command line, run gulp serve - If it quits by itself then there is something wrong
  2. To view the result, click the preview button at the top and click Preview Running Application

To publish your work to Github run these commands in the command line:

gulp publish
git commit -a
git push origin master

Local Machines

System Dependencies

Windows

See WINDOWS.md for instructions on installing these dependencies. these links are download links for installers

64-bit
32-bit

* See WINDOWS.md for details on installing these however, node glixer.js init will install these dependencies for you

Mac OSX
Linux
  • Node.js
  • ruby*
  • ruby-dev*
  • zlib1g-dev*
  • build-essential*
  • git*

* These will be automatically installed with node glixer.js init

Cloning and setup

Open a Command Prompt or Terminal window and type these commands in:

git clone https://github.com/NorthScript/glixer
cd glixer
node ./glixer.js install

Github Pages Setup (For organization/users)

  1. Create a new repository in your user/organization
  • Make sure that initialize this repository with a README is unchecked
  • If you are making this for a user profile, name your repository: yourusername.github.io
  • If you are making this for a organization, make sure that the repository is created and owned by the organization and name it: yourorganization.github.io
  1. clone this repository: git clone https://github.com/north-script/glixer
  2. cd glixer
  3. Remove .git directory (Windows: rmdir /S .git Mac/Linux: rm -r -f .git)
  4. git init
  5. git remote add origin https://github.com/user-or-organization-name/user-or-organization-name.github.io
  6. git commit -a -m "Initial commit"
  7. git push origin master
  8. Optional: npm install

Github Pages Setup (For projects/repositories)

  1. Clone your repository
  2. cd into your repository
  3. clone this repository git clone https://github.com/north-script/glixer
  4. rename the glixer folder to docs.
  5. remove the .git (hidden) folder in your docs folder
  6. stage your changes and commit them.
  7. push your changes to your repository.
  8. Go to your repository settings and enable github pages from your docs folder

Built by

Mike Boardley

Please email me your comments & feedback.

Samuel Brekke

Please contact me for any questions, comments, concerns and, feedback