{"id":21835880,"url":"https://github.com/vtex/speed","last_synced_at":"2025-04-14T09:15:53.689Z","repository":{"id":16559461,"uuid":"19313258","full_name":"vtex/speed","owner":"vtex","description":"VTEX Store development tools - reverse proxy, compilation, minification, optimization and more!","archived":false,"fork":false,"pushed_at":"2024-09-10T20:41:57.000Z","size":1375,"stargazers_count":63,"open_issues_count":22,"forks_count":46,"subscribers_count":38,"default_branch":"master","last_synced_at":"2025-04-14T09:15:31.483Z","etag":null,"topics":["xp-developer"],"latest_commit_sha":null,"homepage":null,"language":"CoffeeScript","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/vtex.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-04-30T12:42:44.000Z","updated_at":"2024-04-26T01:18:40.000Z","dependencies_parsed_at":"2024-11-27T20:31:21.912Z","dependency_job_id":"2001c4cd-8277-43f4-987e-35f04b72176a","html_url":"https://github.com/vtex/speed","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Fspeed","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Fspeed/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Fspeed/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Fspeed/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vtex","download_url":"https://codeload.github.com/vtex/speed/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248852185,"owners_count":21171843,"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":["xp-developer"],"created_at":"2024-11-27T20:25:49.562Z","updated_at":"2025-04-14T09:15:53.655Z","avatar_url":"https://github.com/vtex.png","language":"CoffeeScript","readme":"# VTEX Speed\n\n\u003e ⚠️ This tool is no longer maintained.\n\nVTEX Store development tools - reverse proxy, compilation, minification, optimization and more!\n\n## Presentation - VTEX Day 2014\n\nWatch a presentation about VTEX Speed here (pt-BR): http://firstdoit.github.io/presentations/vtex-day-2014\n\n## Pre-requisites\n\n* Node - http://nodejs.org/\n* Grunt - https://gruntjs.com/\n\n## Install\n\nClone this repo or download and unzip it.\n\n## Quick Start\n\n**Before continuing**, please edit the `accountName` key to the `package.json` file. For example:\n\n```json\n    {\n      \"name\": \"vtex-speed\",\n      \"accountName\": \"your-store-account-name\",\n    }\n```\n\nEnter the folder you cloned or downloaded, install dependencies and run `npm start`:\n\n```shell\n    cd speed\n    npm install\n    npm start\n```\n\nFirst, open your browser here to authenticate:  \n\nhttp://your-store-account-name.vtexlocal.com.br/admin/Site/Login.aspx\n\nThen, open a normal page, like your home:\n\nhttp://your-store-account-name.vtexlocal.com.br/?debugcss=true\u0026debugjs=true\n\n**Important**  You should replace `your-store-account-name` with the accountName of your store. Who would guess, huh?\n\n\nNice! Live Reload has reloaded that stylesheet for you.\n\n## Features\n\nAll files in `src/` are compiled, optimized and copied to `build/` when you run `grunt`.\n\nYou can further configure this process editing `Gruntfile.coffee`.\n\nCurrently supported:\n\n- LiveReload of assets in HTTP and HTTPS\n- Coffee compilation\n- LESS compilation\n- SASS compilation\n- JS and CSS Minification\n- Optimize Images\n- Create Icons SpriteSheet\n\nCheck the `src/` directory for examples.\n\n### Spritesheets\n\nTo create spritesheets for your icons by putting your icons png files into the src/sprite directory. Then you can use render your icons by using the class icon-\u003cfilename\u003e.\n\n### Pages reverse proxy\n\nYou can use VTEX Speed serve HTML pages while developing, simply put your HTML files inside `src/` directory. You can see example page [http://your-store-account-name.vtexlocal.com.br/page-example/](http://your-store-account-name.vtexlocal.com.br/page-example/).\n\n### Compress option\n\nYou can use the flag `--compress` to develop with minified files (JS, CSS, and SASS).\n\n### Changing default port\n\nYou can easily change the proxy port by setting the PORT environment variable, e.g. `PORT=9000 npm start`\n\n## Discover new Grunt plugins\n\nThere are a **ton** of available Grunt plugins for your every need.\n\nGo to http://gruntjs.com/plugins for a complete list.\n\nIf you think there's a plugin that's great for everybody, why don't you [fork this repo and open a pull request](https://github.com/vtex/speed/fork)?\n\n## Feedback\n\nWe always want to hear you! Please report any problems to the issues page:\n\nhttps://github.com/vtex/speed/issues\n\n## FAQ\n\n### What is `ECONNRESET`?\n\nThe HTTP response socket hung up before sending a complete reply.  \nYou probably manually stopped a request on your browser.  \nThus, the proxy shouted: \"I was receiving a response and it stopped abruptly!\"\n\n## Release History\n\n- 2018-09-11    v5.0.0      Add compress option. Allow to use another port. Add support for SASS.\n\n- 2016-05-06    v3.0.0      Update grunt to major 1 and other dependencies\n\n- 2015-03-16    v2.1.0      Update connect-http-please, separate middlewares from Gruntfile\n\n- 2015-03-16    v2.0.0      Replace `connect-tryfiles` with `serve-static` and `proxy-middleware`, adding support to \"vteximg\" host proxying. Update deps. **Important:** `accountName` is now a required property in the `package.json` file.\n\n## License\n\nMIT © [VTEX](https://github.com/vtex)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex%2Fspeed","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvtex%2Fspeed","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex%2Fspeed/lists"}