Skip to content

edpau/bdaytracker-frontend

Repository files navigation

🎂 BdayTracker Frontend

A birthday calendar web app for internal company use.
Built with Vite + React + Tailwind. Connects to a Spring Boot backend to display today’s and upcoming birthdays.

🛠️ Project Stack

Vite TypeScript Prettier TailwindCSS Husky clsx tailwind-merge

This project uses:

  • Vite with React + TypeScript (vite@6.3.5)
  • Tailwind CSS via @tailwindcss/vite plugin
  • Prettier with prettier-plugin-tailwindcss
  • ESLint for linting
  • Husky + lint-staged for pre-commit formatting and lint checks
  • cn() utility (combining clsx + tailwind-merge) for clean, conditional, and conflict-free Tailwind CSS class management

📄 Full developer setup:
👉 docs/dev-setup.md


✅ Setup Instructions

1. Clone and install

git clone https://github.com/edpau/bdaytracker-frontend.git
cd bdaytracker-frontend
npm install

2. Dev scripts

npm run dev       # Start dev server
npm run build     # Type-check + build
npm run preview   # Preview production build
npm run lint      # Manually run ESLint

⚙️ Environment Variables

Create a .env file in the project root. Here's the recommended setup:

# Base API URL for local backend
VITE_API_BASE_URL=http://localhost:8080/api

# Toggle between using mock data or backend
VITE_USE_MOCK=true

📄 See .env.example for a template you can copy.

🔁 Don’t forget:

If you change .env, restart the dev server (npm run dev) for changes to take effect.


📒 Developer Notes

Personal learning logs documenting key decisions, setup patterns, and dev research.


🚦Next Steps (WIP)

  • Add environment variable support via .env
  • Add font and theme token support for light/dark mode
  • Add CI check with ESLint + Prettier
  • Connect to backend API (Spring Boot)

After MVP

  • [ ]Add Zod later to validate backend data shape — helps catch unexpected API changes, ensures type safety, and avoids runtime bugs in production.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors