{"id":26576949,"url":"https://github.com/daveschumaker/bootstrap-node-project","last_synced_at":"2026-04-10T00:04:12.818Z","repository":{"id":83488719,"uuid":"516089399","full_name":"daveschumaker/bootstrap-node-project","owner":"daveschumaker","description":"Quickly setup a new Node.js project with frequently used configuration parameters.","archived":false,"fork":false,"pushed_at":"2024-08-08T01:24:29.000Z","size":1043,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-08-08T03:40:04.273Z","etag":null,"topics":["eslint","javascript","nodejs","prettier"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/daveschumaker.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2022-07-20T18:14:43.000Z","updated_at":"2024-08-08T03:40:12.913Z","dependencies_parsed_at":null,"dependency_job_id":"f0b22a8d-d8a5-43ae-ab26-99f7c5e60e71","html_url":"https://github.com/daveschumaker/bootstrap-node-project","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daveschumaker%2Fbootstrap-node-project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daveschumaker%2Fbootstrap-node-project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daveschumaker%2Fbootstrap-node-project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daveschumaker%2Fbootstrap-node-project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/daveschumaker","download_url":"https://codeload.github.com/daveschumaker/bootstrap-node-project/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245052650,"owners_count":20553162,"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":["eslint","javascript","nodejs","prettier"],"created_at":"2025-03-23T03:34:52.832Z","updated_at":"2025-12-30T19:27:54.934Z","avatar_url":"https://github.com/daveschumaker.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🚧 Bootstrap-Node-Project 🚧\n\n**The problem:** Any time I wanted to create a new Node.js project, I found myself having to dig through old projects to copy over a bunch of configuration files, like `.prettierrc` and `.eslintrc` and repeatedly installing the same `eslint` plugins from `npm`. It took a bit of time and effort to get my initial project up and running, since I wanted everything to be _just right_. Often, by the time I had the project scaffolding setup, I had lost whatever motivation I had to start working on some new side project. Surely, there must be an easier way.\n\nThere is!\n\n**The solution (for my purposes, at least):** This is a project I created to quickly setup a new dev environment for Node.js projects using configuration settings that I've frequently used in my previous work. This script greatly simplifies the process of getting a basic project template up and running, with optional support for tests, TypeScript and setting up an API using Express. This also provided a good reason to experiment with creating command line applications in Node.js.\n\nOn my M1 Macbook Air, I can get a new project up and running in **~30 seconds**. 🙌\n\n![Screenshot of Bootstrap-Node in action](bootstrap-node-demo.gif)\n\n## To use 🚦\n\n1. Clone this project to your local machine: `git clone git@github.com:daveschumaker/bootstrap-node-project.git`\n2. `\u003e cd ./bootstrap-node-project`\n3. `\u003e npm install`\n4. `\u003e npm run config:setup` to create an empty `config.js` file that can be used to set default name and email address for new projects. Adding defaults to this file is optional.\n5. Install as a global command line app: `npm run install:global`\n6. Invoke `bootstrap-node` anywhere on your system to get started.\n\n## Details ℹ️\n\nThis script installs the following into a new project:\n\n- `eslint` / `prettier` / [various eslint plugins] - handles code formatting and linting in a new project.\n- `husky` - Enable precommit hooks for enforcing linting and code styling\n- `tap` - Uses Node TAP (Test Anything Protocol) for quick and easy testing and creates a basic test\n- `express` (optional) - Quickly setup API endpoints and routes using Express\n- `typescript` 🙌 (optional) - Can optionally setup projects with TypeScript. (Current default is true)\n- `nodemon` (optional) - Can optionally setup projects with nodemon. (Current default is false)\n\n## Directory structure 🌴\n\nAfter a new project is bootstrapped, the directory structure looks like this:\n\n```text\nmy-cool-project/\n├─ .husky/\n├─ node_modules/\n├─ src/\n│  ├─ index.js (ts)\n│  ├─ index.test.js (ts)\n├─ .eslintrc.json\n├─ .gitignore\n├─ .prettierrc\n├─ package-lock.json\n├─ package.json\n├─ README.md\n├─ tsconfig.json (optional)\n```\n\n## Issues 🚨\n\nAn ongoing issue that I haven't been able to figure out is that a new project seems to be created with elevated permissions, meaning that you cannot delete the folder as your current user. For example, if you've bootstrapped a new project into the folder `./my-cool-project`, you might see this when trying to remove it.\n\n```text\n\u003e rm -rf my-cool-project\nrm: my-cool-project: Permission denied\n```\n\nThe solution seems to be either to elevate yourself to root and run `sudo rm -rf my-cool-project` or to add a dot-slash to indicate the relative path: `rm -rf ./my-cool-project` seems to work as well.\n\n## Future TODOs ✅\n\n- Add more configuration options:\n- Choose license type\n- Private or public package\n- Option to choose `npm` or `yarn`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaveschumaker%2Fbootstrap-node-project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdaveschumaker%2Fbootstrap-node-project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaveschumaker%2Fbootstrap-node-project/lists"}