Skip to content

daboigbae/dad-firebase-functions-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

dad-firebase-functions-template

A minimal Firebase Cloud Functions starter template with TypeScript.
Includes: Firebase Functions v2, TypeScript, ESLint, and a sample hello HTTP function.


🚀 Quick Start

Option A — Use this template

  1. Click Use this template on GitHub.
  2. Clone your new repo:
    bash
    git clone https://github.com/YOUR_GITHUB_USERNAME/dad-firebase-functions-template my-app
    cd my-app
    

Option B — Clone with degit

bash
npx degit daboigbae/dad-firebase-functions-template YOUR_PROJECT_NAME
cd YOUR_PROJECT_NAME

✅ Checklist

  • Install dependencies: cd functions && npm install
  • Replace YOUR_FIREBASE_PROJECT_ID in .firebaserc.
  • Update the name field in package.json to your project name.
  • Run firebase login and firebase use --add.
  • Build the project: cd functions && npm run build
  • Test locally with npm run dev (or use npm run serve to build + run emulator)
  • Run linting: cd functions && npm run lint
  • Deploy with npm run deploy.

📂 Project Structure

YOUR_PROJECT_NAME/
├── firebase.json          # Emulator + deploy config
├── .firebaserc            # Project alias (replace with your ID)
├── package.json           # Root scripts (update name field)
├── functions/
│   ├── src/
│   │   ├── index.ts       # Main exports + sample hello function
│   │   └── firebase/
│   │       └── authentication/
│   │           ├── onUserSignup.ts    # User creation handler
│   │           └── onUserDelete.ts    # User deletion handler
│   ├── tsconfig.json      # TypeScript config
│   └── package.json       # Functions deps + build scripts
└── README.md              # You are here

Made with ❤️ by Digital Art Dealers

About

A minimal Firebase Cloud Functions starter template with TypeScript.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published