Giter Club home page Giter Club logo

shopify.github.com's Introduction

Shopify Open Source

Shopify's Open Source page is built with Jekyll and Sass and hosted on GitHub Pages.

All of the data comes from Jekyll. Any change in index.html (including whitespace commits - e.g.) will trigger a rebuild and update all of the numbers.

To include a repo in the list, add it to optInRepos in javascripts/custom-repos.js. The repo must be owned by Shopify. To include non-Shopify repos, use customRepos. Set a defined project language or custom avatar in the same file.

If you want to run it locally

  1. Clone this branch or download the zip and navigate to the folder in terminal
  2. Install Jekyll: gem install jekyll
  3. Install Sass: gem install sass
    • Use sass -v to make sure it worked
  4. Install Compass: gem install compass
  5. Make sure everything is setup with bundle install
  6. Run bundle exec jekyll serve
  7. In another terminal window, run compass watch
  8. Access the page at http://localhost:4000

Notes about local build

  • bundle exec jekyll serve will compile the Jekyll and Sass files into static assets in the _site folder each time a file is saved. That folder is excluded from the repo.
  • compass watch will update ie.css and main.css.
  • Use rake build to manually parse SCSS files.
  • Your local build will be nearly empty because:
    • The page uses Jekyll's site.github.public_repositories object to get the repo data. This data is only available when live.
    • Custom repo data is generated by Github's JS API, so it will show up locally.

Content Management

  • The content for each project comes from the GitHub Pages for that repo. This can be from a gh-pages branch, or from the /docs directory, based on the GitHub Pages settings. Using the /docs directory is preferred as it's less confusing for contributors.

Dependencies (all included)

shopify.github.com's People

Contributors

cshold avatar tranhelen avatar raulriera avatar nathanpjf avatar beefchimi avatar kaelig avatar shawnfrench avatar shaynep avatar richgilbank avatar cjoudrey avatar camdavidsonpilon avatar ashmaroli avatar andyw8 avatar yagnik avatar natalysheinin avatar imjching-shopify avatar jahfer avatar pseudomuto avatar jomo avatar sirupsen avatar catherinejones avatar danieljette avatar davidcornu avatar jonniesweb avatar wildmaples avatar sbfaulkner avatar neal-saunders avatar arthurnn avatar klautcomputing avatar sav007 avatar

Watchers

James Cloos avatar  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.