{"id":13562577,"url":"https://github.com/YJPL/Supply","last_synced_at":"2025-04-03T18:33:57.025Z","repository":{"id":42714771,"uuid":"236467011","full_name":"YJPL/Supply","owner":"YJPL","description":"🛍  Supply is a free e-commerce Jekyll theme with Gumroad integration.","archived":false,"fork":false,"pushed_at":"2024-04-27T18:00:00.000Z","size":4904,"stargazers_count":45,"open_issues_count":1,"forks_count":13,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-05-02T00:20:25.279Z","etag":null,"topics":["e-commerce","ecommerce","ecommerce-template","ecommerce-website","gumroad","jamstack","jekyll","jekyll-template","jekyll-theme","liquid","netlify","tachyons-css"],"latest_commit_sha":null,"homepage":"https://supply.templates.supply","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/YJPL.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["YJPL"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2020-01-27T10:33:49.000Z","updated_at":"2024-05-14T14:50:14.147Z","dependencies_parsed_at":"2023-12-20T16:36:22.541Z","dependency_job_id":"2663ff4d-13e3-4e51-87c2-eebdc793b7c9","html_url":"https://github.com/YJPL/Supply","commit_stats":null,"previous_names":[],"tags_count":3,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YJPL%2FSupply","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YJPL%2FSupply/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YJPL%2FSupply/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YJPL%2FSupply/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/YJPL","download_url":"https://codeload.github.com/YJPL/Supply/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247057148,"owners_count":20876522,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["e-commerce","ecommerce","ecommerce-template","ecommerce-website","gumroad","jamstack","jekyll","jekyll-template","jekyll-theme","liquid","netlify","tachyons-css"],"created_at":"2024-08-01T13:01:10.101Z","updated_at":"2025-04-03T18:33:51.994Z","avatar_url":"https://github.com/YJPL.png","language":"CSS","funding_links":["https://github.com/sponsors/YJPL","https://www.buymeacoffee.com/alternatyves/","https://ko-fi.com/T6T013TB72"],"categories":["CSS"],"sub_categories":[],"readme":"## Supply, an e-commerce Jekyll theme with Gumroad integration\n\n[![Netlify Status](https://api.netlify.com/api/v1/badges/d0fa21a2-19fa-45da-a77a-024c58295e7f/deploy-status)](https://app.netlify.com/sites/supply-demo/deploys)\n\nSupply is an e-commerce template for [Jekyll](https://jekyllrb.com/) + [Gumroad](https://gumroad.com), designed with [Tachyons CSS](https://github.com/tachyons-css/tachyons).\n\nIf you are a Gumroad creator, you can use Supply with Jekyll to display and sell products on your site or blog.\n\n[Demo Site with documentation](https://supply.templates.supply)\n\nBrowse through a live demo: [https://templates.supply](https://templates.supply).\n\n![Supply template screenshot](/images/screenshot.png)\n\nSupply is designed by [alternatyves](https://alternatyves.com/).\n\nFind more [templates, themes, and Jekyll tutorials](https://jekyllrb.com/resources/).\n\n## Features\n\n- [x] List \u0026 display products, thanks to Jekyll's collections\n- [x] Take payment online using [Gumroad](https://gumroad.com)\n- [x] Contact form with [formcarry](https://www.formcarry.com)\n- [x] Map with [Leaflet](https://leafletjs.com \"Leaflet is the leading open-source JavaScript library for mobile-friendly interactive maps.\") thanks to the [jekyll-leaflet plugin](https://github.com/DavidJVitale/jekyll-leaflet)\n- [x] [jekyll-archives](https://github.com/jekyll/jekyll-archives) to build and sort through categories \u0026 tags pages\n- [x] Custom variables\n- [x] RSS/Atom feed\n- [x] SEO tags\n- [x] Microdata markup\n- [x] Jekyll `livereload` + NPM for fast development\n- [x] Built-in site search\n\n## Setup\n\n1. Install [Jekyll](https://jekyllrb.com/docs/installation/)\n2. Add your site and author details in `_config.yml`.\n3. Get a workflow going to see your site's output with Jekyll locally.\n\n*Supply* was built with [Jekyll](http://jekyllrb.com/) version 4.0.0 and should support newer versions as well.\n\nInstall the dependencies with [Bundler](http://bundler.io/):\n\n~~~bash\n$ bundle install\n~~~\n\nRun `jekyll` commands through Bundler to ensure you're using the right versions:\n\n~~~bash\n$ bundle exec jekyll serve\n~~~\n\n### Config\nAdd your custom configuration in the ```_config``` file.\n\n### Navigation\n\n* Exposed as a data file to give clients better access\n* Set in the *Data* / *Navigation* section, look for ```navigation.yml``` in  ```_data```.\n\n### Footer\nLook for ```footer.html``` in ```_includes``` to add and change your footer links.\n\n### Contact Page\nTo add you formcarry endpoint URL to `_config.yml`, you'll need a fromcarry account, please refer to [formcarry documentation](https://formcarry.com/documentation/getting-started)\n\nAdd your map coordinates if you want to display a map. Please refer to the [jekyll-leaflet plugin](https://davidjvitale.com/tech/jekyll-leaflet/getting-started/) and [Leaflet](https://leafletjs.co\n  m) documentation for customizing your map(s).\n\n### Product Pages\nIf you have products on Gumroad, you can start adding product pages right away. Within the Supply theme, you'll find a sample of a product page with free products, ```free-products.html```, located in ```_pages```.\n\n\n## Develop\n\n### Building front-end assets: styles and scripts\n\n4. Install Node module dependencies:\n\n~~~bash\nnpm install\n~~~\n\n\n### Tachyons\n\nYou can change the site styling using [Tachyons](http://tachyons.io), look for the CSS in the `sup-theme` file, located in the `src` folder.\n\nTachyons is a CSS toolkit and design system based on using components. Please refer to [Tachyons documentation](http://tachyons.io/docs/), you can also start with [https://github.com/dwyl/learn-tachyons](https://github.com/dwyl/learn-tachyons)\n\nOnce you are done with your style changes, run:\n\nRun the npm run \n~~~bash\nbuild:css\n~~~\n\nThat will process all your CSS files in one readable file located in `assets/css/sup-tachyons.css`. \n\nto minify your css you can run \n\n```\nnpm run minify-css\n```\n\nor \n\n```\nnpm run start\n```\n\nto minify and build the site locally.\n\n\n### npm commands with browser reload\n\nSupply uses a couple of custom Postcss npm scripts. Make sure your dependencies are installed: `npm install`. Type `npm outdated` to see if you have outdated versions, then install any outdated dependencies.\n\nOnce that is done, to build your site \u0026 concatenate your CSS (in `assets` -\u003e `CSS`), simply run:\n\n```\nnpm run start\n```\n\nThis command builds the site locally on port 4000, you can quickly revise design changes thanks to `livereload`.\n\n## Editing\n\n### Posts\n\n* Add, update, or remove a post in the *Posts* collection.\n* Change the defaults when new posts are created in `_posts/_defaults.md`.\n\n### Collections\nTo display products, Supply uses a collection called ```product```\nYou will find a series of product samples in the `_products` collection folder. By design, all the products are on display on the home page, in Supply, that is `ìndex.html`.\nYou can manually create pages based on this index to [sort your products or any other collection by custom variable](/custom-variables/).\n\nYou can also add your products in regular posts, using the Gumroad [overlay](/gumroad-overlay/), [embed](/gumroad-embed/), and [hyperlinks](/gumroad-hyperlink/) method, thanks to an include snippet.\n\nWrite something like:\n\n```html\n{% raw %}\u003ca href=\"https://gum.co/supply class=\"no-underline pv2 grow db\"\u003e\u003cimg class=\"w-100\" src=\"/images/screenshot.png\"\u003e\u003c/a\u003e\n\n{% include gumroad-overlay.html id=\"supply\" %}{% endraw %}\n```\n\nto get a product display like this:\n\n\u003ca href=\"https://gum.co/supply\" class=\"no-underline pv2 grow db\"\u003e\u003cimg class=\"w-100\" src=\"/images/supply-overlay.png\"\u003e\u003c/a\u003e\n\n## Copyright / License\n*Supply* is designed by [alternatyves](https://alternatyves.com/) and licensed under the [MIT license](https://github.com/YJPL/Supply/blob/master/LICENSE).\n\n[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/YJPL/Supply/pulls)\n\nPlease use and [contribute to *Supply* ](https://github.com/YJPL/Supply/pulls).\n\n\u003ca href=\"https://www.buymeacoffee.com/alternatyves/\" target=\"_blank\"\u003e\u003cimg src=\"https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png\" alt=\"Buy Me A Coffee\" style=\"height: auto !important;width: auto !important;\" \u003e\u003c/a\u003e\n\n[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/T6T013TB72)\n\n## Who is using this?\n\n- [x] [templates.supply](https://templates.supply)\n\nAre you using Supply? [Let me know!](https://github.com/YJPL/supply/edit/master/README.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FYJPL%2FSupply","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FYJPL%2FSupply","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FYJPL%2FSupply/lists"}