A problem that often happens to me: I get the inspiration to whip up something in Node.js (for fun, for experimentation, for a side project, etc) but then I realize that I need to go through the process of actually setting things up before I can even start writing some code.
Usually, I have to dig through previous projects and copy over my eslint and prettier config files, read through some documentation and remember how to setup TypeScript again, install the correct dependencies for running tests. Before I know it, I’m bored and tired and no longer interested in doing whatever I was going to do.
I decided to experiment with some command line tools and created a Node.js script that can help me quickly bootstrap a new project with common configuration parameters that I use. It’s available on GitHub: Bootstrap Node Project.
The GIF above shows this tool in action. I’m able to get the scaffolding for a new project up and running within about 20 seconds! After running, the project structure looks like this (with associated npm start and test scripts, all ready to go). That is pretty awesome.
my-cool-project/ ├─ .husky/ ├─ node_modules/ ├─ src/ │ ├─ index.js (.ts) │ ├─ index.test.js (.ts) ├─ .eslintrc.json ├─ .gitignore ├─ .prettierrc ├─ package-lock.json ├─ package.json ├─ README.md ├─ tsconfig.json (optional)
Obviously, it’s highly opinionated and caters to configuration options that I personally like to use. But I figure it’s a great resource for anyone who wishes to roll their own utility to quickly bootstrap projects as well.