{"id":15010588,"url":"https://github.com/nodejs/devcontainer","last_synced_at":"2025-10-19T22:30:54.292Z","repository":{"id":38334781,"uuid":"399558707","full_name":"nodejs/devcontainer","owner":"nodejs","description":"developer environment for Node.js core","archived":false,"fork":false,"pushed_at":"2025-10-15T12:53:41.000Z","size":35,"stargazers_count":28,"open_issues_count":2,"forks_count":11,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-10-16T07:52:44.931Z","etag":null,"topics":["devcontainer","docker","dockerfile","nodejs"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/nodejs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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,"zenodo":null},"funding":{"github":"nodejs","open_collective":"nodejs"}},"created_at":"2021-08-24T17:57:45.000Z","updated_at":"2025-10-15T12:53:44.000Z","dependencies_parsed_at":"2024-11-06T17:34:01.475Z","dependency_job_id":"c635b898-1ba6-43d2-b644-1895b244731c","html_url":"https://github.com/nodejs/devcontainer","commit_stats":{"total_commits":25,"total_committers":2,"mean_commits":12.5,"dds":"0.040000000000000036","last_synced_commit":"f2469c6356e379d170c3b1d4ac49a888b2320082"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nodejs/devcontainer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodejs%2Fdevcontainer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodejs%2Fdevcontainer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodejs%2Fdevcontainer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodejs%2Fdevcontainer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nodejs","download_url":"https://codeload.github.com/nodejs/devcontainer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodejs%2Fdevcontainer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279927565,"owners_count":26245503,"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","status":"online","status_checked_at":"2025-10-19T02:00:07.647Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["devcontainer","docker","dockerfile","nodejs"],"created_at":"2024-09-24T19:34:53.328Z","updated_at":"2025-10-19T22:30:53.950Z","avatar_url":"https://github.com/nodejs.png","language":"Shell","readme":"# Node.js Developer Container (`devcontainer`)\n\n## Usage\n\n### Setup\n\n#### Running with Docker Desktop\n\nTo run locally on your machine, you'll want to install [Docker Desktop](https://www.docker.com/products/docker-desktop/) and start it up.\n\nOnce you've got Docker Destop running, you can run the following command to pull and start the image:\n\n```sh\ndocker pull nodejs/devcontainer:nightly\ndocker run -it nodejs/devcontainer:nightly /bin/bash\n```\n\nOnce you've run those commands, you'll be in a shell inside the running container. If you need to escape, type `exit`. You should be good to jump to [Working in the Container](#working-in-the-container).\n\n### Working in the Container\n\n- The project is located at `/home/developer/nodejs/node`.\n  - Once this directory is your active directory, you should be good to go.\n  - If you want to build the project in the container, run with ninja (rather than just make):\n    - `/home/developer/nodejs/node/configure --ninja \u0026\u0026 make -C /home/developer/nodejs/node`\n- You should be able to attach any editor that supports the concept of [`devcontainers`](https://containers.dev/) to this \n\n### Personal Configuration\n\nAssuming you've already got the Docker container running:\n\n- Set the git `origin` to your own fork rather than `nodejs/node`\n  - Example, where `USERNAME` is your GitHub username: `$ git remote set-url origin https://github.com/USERNAME/node.git`\n  - Verify the remote is valid: `git remote -v`\n- Set up your git name and email\n  - `git config --global user.name \"YOUR NAME\"`\n  - `git config --global user.email \"YOUR@EMAIL.TLD\"`\n- Add your SSH key\n - Preferably one that's already [published to GitHub](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account)\n - Alternatively, you can install the [`gh` CLI](https://cli.github.com/) and run `gh auth login` to login and add a new key.\n\n## Development\n\nSome useful commands:\n- `docker build .` - build the current Dockerfile\n- `docker image ls` - list the images and IDs\n- `docker run -it \u003cimage id\u003e /bin/bash` - run a container and shell into it\n- `docker tag \u003cimage id\u003e devcontainer:nightly` - run to tag an image as `nightly`\n\n\n### Tips and Tricks for Debugging Failed Builds and Otherwise Developing in This Repo\n\nSome notes on what's been helpful:\n\n- Break up the `RUN` statement in the [Dockerfile][] into multiple `RUN` statements, each containing a single command. This provies more precise information about what exactly is failing if the Docker build fails and isn't providing helpful output.\n- Sometimes removing the `RUN` statement in the [Dockerfile][] and running `docker build`, running the built container, and individually running each command in the running container is a better development experience than working outside of the built container.\n\n[Dockerfile]: ./Dockerfile\n","funding_links":["https://github.com/sponsors/nodejs","https://opencollective.com/nodejs"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodejs%2Fdevcontainer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnodejs%2Fdevcontainer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodejs%2Fdevcontainer/lists"}