{"id":15011412,"url":"https://github.com/rajarakoto/node-boilerplate","last_synced_at":"2025-04-12T03:32:05.117Z","repository":{"id":216675199,"uuid":"742007810","full_name":"RajaRakoto/node-boilerplate","owner":"RajaRakoto","description":"Minimalistic boilerplate to quick-start Node.js development in TypeScript 🚀","archived":false,"fork":false,"pushed_at":"2024-09-22T10:39:03.000Z","size":703,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-25T23:34:56.805Z","etag":null,"topics":["boilerplate","bun","bunjs","minimalist","node","nodejs","template","typescript"],"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/RajaRakoto.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":["RajaRakoto"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2024-01-11T15:14:01.000Z","updated_at":"2024-09-22T10:39:07.000Z","dependencies_parsed_at":"2024-03-15T20:32:31.851Z","dependency_job_id":"928990b0-4c57-4082-9c57-939650f5864e","html_url":"https://github.com/RajaRakoto/node-boilerplate","commit_stats":null,"previous_names":["rajarakoto/node-typescript-boilerplate","rajarakoto/node-boilerplate"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RajaRakoto%2Fnode-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RajaRakoto%2Fnode-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RajaRakoto%2Fnode-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RajaRakoto%2Fnode-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RajaRakoto","download_url":"https://codeload.github.com/RajaRakoto/node-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248512835,"owners_count":21116688,"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":["boilerplate","bun","bunjs","minimalist","node","nodejs","template","typescript"],"created_at":"2024-09-24T19:41:03.925Z","updated_at":"2025-04-12T03:32:04.777Z","avatar_url":"https://github.com/RajaRakoto.png","language":"JavaScript","funding_links":["https://github.com/sponsors/RajaRakoto"],"categories":[],"sub_categories":[],"readme":"# node-boilerplate 🚀\n\n[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com) [![forthebadge](https://forthebadge.com/images/badges/for-you.svg)](https://forthebadge.com) [![forthebadge](https://forthebadge.com/images/badges/open-source.svg)](https://forthebadge.com) [![forthebadge](https://forthebadge.com/images/badges/uses-git.svg)](https://forthebadge.com) [![forthebadge](https://rajarakoto.github.io/github-docs/badge/build-by.svg)](https://forthebadge.com)\n\n![Git](https://img.shields.io/badge/-Git-777?style=flat\u0026logo=git\u0026logoColor=F05032\u0026labelColor=ffffff) ![Gitub](https://img.shields.io/badge/-Gitub-777?style=flat\u0026logo=github\u0026logoColor=777\u0026labelColor=ffffff)\n\n**Developer Ready: A comprehensive template. Works out of the box for most Node.js projects. This project is intended to be used with the latest active LTS release of Node.js.**\n\nInstant Value - All basic tools included and configured:\n\n- 🚀 Typescript \u003e= 5.3\n- 🌐 Node.js \u003e= 20.10.0\n- 🧅 Use Bun as package manager\n- 🌈 ES\n- 🧪 Biome for code formatting and linting\n- ✅ Jest or Bun test for fast unit testing and code coverage\n- 📚 Type definitions for Node.js and Jest\n- ⚙️ EditorConfig for consistent coding style\n- 📦 NPM scripts for common operations\n- ⚡ Reproducible environments thanks to Volta\n- 🛠️ Example configuration for GitHub Actions\n- 📝 Simple example of TypeScript code and unit test\n- 🐗 Run tasks with Grunt (example for backup)\n- 🚄 Build faster with ESBuild\n- 🖥️ Ungit for version control (git) with a GUI\n- 🔑 Dotenv for environment variables\n- 🔄 Nodemon for automatic restarts node server in development\n- 🔌 Tsc-watch for automatic transpile source files in development\n- 📘 Runtime library for TypeScript helpers with tslib\n- 🗃️ Utility functions for working with ts-api-utils\n\n---\n\n### 📌 Usage\n\nTo use this template, use the following commands:\n\n```bash\nbun create github.com/RajaRakoto/node-boilerplate \u003cproject-name\u003e\ncd \u003cproject-name\u003e\nbun run pkg-upgrade # to upgrade outdated dependencies in interactive mode\n```\n\n\u003e NOTE 1: I employ the `MIT license` for this starter kit, which includes my name and GitHub profile. Please remember to adjust or remove it if deemed unnecessary.\n\n\u003e NOTE 2: In order to help you better understand the structure of this boilerplate, there is a `README.md` file in each subdirectory of src.\n\n\u003e NOTE 3: For certain configurations in the `package.json` file, you need to modify them to tailor them to your project (e.g: name, description, author, keywords, main, repository, ...).\n\n---\n\n### 📌 NPM Scripts\n\n**Start**\n\n- 📜 `start` - Run your application with Node.js.\n- 📜 `start:bundle` - Run your application with Node.js using the bundled JavaScript file from dist.\n\n**Clean**\n\n- 📜 `clean` - Remove coverage data, prod, build.\n\n**Development**\n\n- 📜 `dev:tsc:watch` - Interactive watch mode to automatically transpile source files with tsc-watch in development.\n- 📜 `dev:nodemon:watch` - Interactive watch mode to automatically restart Node.js server in development with nodemon.\n\n**Build**\n\n- 📜 `build` - Transpile TypeScript to ES6.\n- 📜 `build:watch` - Interactive watch mode to automatically transpile source files .\n- 📜 `build:bundle` - Bundle source files with ESbuild.\n\n**Testing**\n\n- 📜 `test` - Run bun test.\n- 📜 `test:watch` - Interactive watch mode to automatically re-run tests with bun.\n\n**Linting and Formatting**\n\n- 📜 `biome:start` - Starts the Biome daemon server. You can specify a custom configuration file path using the `--config-path` option.\n- 📜 `biome:stop` - Stops the Biome daemon server.\n- 📜 `biome:fix` - Runs a source code check and applies automatic fixes (linter \u0026 formatter) according to the defined rules.\n- 📜 `biome:unsafe` - Works like `biome:fix`, but may apply more invasive or risky changes.\n\n**Backup and Dependency Management**\n\n- 📜 `backup` - Backup files with Grunt.\n- 📜 `pkg-check` - Check useless dependencies with depcheck.\n- 📜 `pkg-upgrade` - Upgrade outdated dependencies (interactive mode) with npm-check-updates.\n\n**Versioning**\n\n- 📜 `versioning` - Start ungit server.\n\n**NPM Commands**\n\n- 📜 `npm-version:major` - Increments the major version number of your project using npm.\n- 📜 `npm-version:minor` - Increments the minor version number of your project using npm.\n- 📜 `npm-version:patch` - Increments the version patch number of your project using npm.\n\n**NVM**\n\n- 📜 `nvm` - Manage multiple node.js versions. Easily switch between node versions per project to ensure compatibility.\n\n\u003e NOTE: `dev.tsc.watch` and `dev:nodemon:watch` script are designed to run at the same time when developing your application.\n\n---\n\n### 📌 Similar\n\nYou can also check out my other starter projects:\n\n- 🚀 [bun-boilerplate](https://github.com/RajaRakoto/bun-boilerplate)\n- 🚀 [react-boilerplate](https://github.com/RajaRakoto/react-boilerplate)\n- 🚀 [next-boilerplate](https://github.com/RajaRakoto/next-boilerplate)\n- 🚀 [qwik-boilerplate](https://github.com/RajaRakoto/qwik-boilerplate)\n- 🚀 [vscode-boilerplate](https://github.com/RajaRakoto/vscode-boilerplate)\n- 🚀 [cli-boilerplate](https://github.com/RajaRakoto/cli-boilerplate)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frajarakoto%2Fnode-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frajarakoto%2Fnode-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frajarakoto%2Fnode-boilerplate/lists"}