{"id":25519667,"url":"https://github.com/aligent/stencil-docker","last_synced_at":"2025-04-11T00:32:54.187Z","repository":{"id":40306049,"uuid":"281803352","full_name":"aligent/stencil-docker","owner":"aligent","description":"Dockerised Stencil command for BigCommerce","archived":false,"fork":false,"pushed_at":"2025-03-19T22:54:04.000Z","size":122,"stargazers_count":7,"open_issues_count":0,"forks_count":3,"subscribers_count":24,"default_branch":"main","last_synced_at":"2025-04-02T23:46:10.364Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aligent.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}},"created_at":"2020-07-22T23:25:04.000Z","updated_at":"2025-03-19T22:54:08.000Z","dependencies_parsed_at":"2023-11-07T07:26:21.898Z","dependency_job_id":"1e0fc825-f5ec-4ef4-a7ea-58b7adbda7af","html_url":"https://github.com/aligent/stencil-docker","commit_stats":null,"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fstencil-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fstencil-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fstencil-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fstencil-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aligent","download_url":"https://codeload.github.com/aligent/stencil-docker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248322770,"owners_count":21084336,"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":[],"created_at":"2025-02-19T17:29:19.642Z","updated_at":"2025-04-11T00:32:54.167Z","avatar_url":"https://github.com/aligent.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Introduction\n\nDocker image for running the stencil command without requiring it to be installed. We have experienced a number of annoying issues installing the cli from time-to-time, as well as it have a huge number of deprecated node modules included. This method of use does not require you to run the npm install process or have any of the prerequisites installed (although it does require you to have Docker installed).\n\nThe image is available on Docker Hub as [aligent/stencil](https://hub.docker.com/r/aligent/stencil).\n\nThis code simply wraps [bigcommerce/stencil-cli](https://github.com/bigcommerce/stencil-cli) in docker for convenience.\n\n## Installation\n\nEnsure you have a .npm directory for caching dependancies (`mkdir -p ~/.npm`)\n\nAdd the following line to your `~/.bash_aliases` (or `.bash_profile`, `.bashrc`, etc) file to be able to run it easily...\n\n```bash\nalias stencil='docker run --rm -p 3000:3000 -p 3002:3002 -it --volume ~/.npm:/home/node/.npm --volume $PWD:/app aligent/stencil stencil'\n```\n\nYou will then need to reload your bashrc file, either by running `. ~/.bashrc` or starting a new terminal session.\n\nIf you want to specify a **specific version** of stencil, you can use the version number in the alias (Docker tags should match\nthe version number of the cli), eg \n\n```bash\nalias stencil='docker run --rm -p 3000:3000 -p 3002:3002 -it --volume ~/.npm:/home/node/.npm --volume $PWD:/app aligent/stencil:3.8.5 stencil'\n```\n\n## Usage\n\nYou can now run stencil normally.\n\nTo start using it with the cornerstone theme:\n\n1. Clone the theme `git clone https://github.com/bigcommerce/cornerstone.git \u0026\u0026 cd cornerstone`\n2. Install deps `node-run npm install`\n3. Init stencil `stencil init`\n\n## Development / Updates\n\nWe gladdly accept contributions, and if you have issues please log them to Github issues.\n\nTo test the building of the docker container locally, a simple script [test-stencil.sh](./test-stencil.sh) can be used. It will build the container\nand then output the stencil cli version. To update the stencil version, simply edit [Dockerfile](./Dockerfile) on the line where it installs stencil.\n\nAfter a new tag is pushed to this repo it is automatically built in Docker Hub. Version tags should match the Stencil CLI version.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faligent%2Fstencil-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faligent%2Fstencil-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faligent%2Fstencil-docker/lists"}