Project Template

👋 Welcome

This is my personal base / blank project template that I layer additional things on top of (and tweak) for various projects both personal and professionally.

🎯 What Is This?

A template repository with some sane defaults that I prefer such as:

• git configuration
• code editor configuration (Vscode)
• Node configuration
• PNPM (as package manager)
• Prettier Configuration

📋 Prerequisites

Before using this template, ensure you have the following installed:

• Node.js v22.18.0 - Use nvm for easy version management

  nvm install
  nvm use

• PNPM v10.18.3+ - Install globally or use corepack

  npm install -g pnpm@10.18.3
  # OR use corepack (built into Node.js 16.13+)
  corepack enable

🚀 Getting Started

1. Use this template - Click "Use this template" on GitHub or clone it:

   git clone https://github.com/FrancisVillarba/Template-Node-Base.git my-project
   cd my-project

2. Install dependencies:

   pnpm install

3. Customise for your project:

   • Update package.json with your project name, description, and author
   • Modify or remove this README
   • Start building in the src/ directory

📁 Project Structure

.
├── src/              # Source code goes here
├── docs/             # Documentation (ADRs, guides, FAQs)
├── tools/            # Helper scripts and utilities
├── .github/          # GitHub configuration goes here (such as GHA, Dependabot etc.)
├── .vscode/          # VSCode recommended extensions
└── ...config files   # EditorConfig, Prettier, git configs

✨ Features

Git Configuration

• .gitignore - Comprehensive ignore patterns for Node.js, macOS, Windows, Linux, and IDEs
• .gitattributes - Ensures consistent line endings (LF) across platforms

Editor Configuration

• EditorConfig - Consistent coding styles across different editors
• VSCode Extensions - Recommended extensions for best experience:
  • Code Spell Checker
  • EditorConfig
  • Prettier
  • Markdown Lint

Code Formatting

• Prettier - Configured with:
  • Single quotes
  • ES5 trailing commas
  • All other settings use Prettier defaults

Node.js Setup

• Node v22.18.0 - Pinned via .nvmrc
• PNPM v10.18.3 - Fast, disk-efficient package manager
• .npmrc - PNPM configuration (loglevel: info)

📄 License

This project is licensed under the MIT License — see the LICENSE file for details.

You're free to learn from this code, fork it, and adapt it for your own projects. Attribution is greatly appreciated but not required!

💬 Get in Touch

• LinkedIn: FrancisVillarba

^ Don't forget to overwrite and change the README documentation as you see fit!